[
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/apps/chat/projects",
  "parameter": "date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. The day to get project activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/apps/chat/projects",
  "parameter": "ending_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/apps/chat/projects",
  "parameter": "filter",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/apps/chat/projects",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"rbac_group_id\" or \"user_id\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "rbac_group_id",
   "user_id"
  ],
  "description": "Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/apps/chat/projects",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of results per page (1-1000, default 100).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/apps/chat/projects",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/apps/chat/projects",
  "parameter": "order_by",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/apps/chat/projects",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/apps/chat/projects",
  "parameter": "starting_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/chat_projects/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/artifacts",
  "parameter": "date",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. The day to get artifact activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/artifacts",
  "parameter": "filter",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `artifact_type`, `is_shared`, `product`, `rbac_group_id`, `user_id`. Value forms: `artifact_type` is a canonical artifact MIME type (e.g. `text/markdown`) or `other`; `is_shared` is `true` or `false`; `product` is `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/artifacts",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"product\" or \"rbac_group_id\" or \"user_id\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "product",
   "rbac_group_id",
   "user_id"
  ],
  "description": "Dimensions to break results out by: `product`, `user_id` and/or `rbac_group_id`. The ungrouped artifact-type cube is finite and returned in full; grouped queries multiply the cube and paginate via `next_page`. `product` takes the values `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts). `rbac_group_id` attributes a user to every group they held at any point during the requested UTC day, so grouped rows are not an exclusive partition. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/artifacts",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum rows to return (1-1000, default 100). The ungrouped artifact-type cube is finite and returned in full; `limit` is the page size only when `group_by[]` multiplies the cube.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/artifacts",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field. Only valid with `group_by[]` — the ungrouped cube is never paginated.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/artifacts/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/connectors",
  "parameter": "date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. The day to get connector usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/connectors",
  "parameter": "ending_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/connectors",
  "parameter": "filter",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `connector_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `connector_name` matches case-insensitively, a display name such as 'GitHub MCP' also matches its normalized stored form ('github'), and for rows whose `connector_name` is an opaque connector id the connector's display name (`connector_display_name`) also matches; `product` is one of `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/connectors",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"product\" or \"rbac_group_id\" or \"user_id\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "product",
   "rbac_group_id",
   "user_id"
  ],
  "description": "Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/connectors",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of results per page (1-1000, default 100).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/connectors",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/connectors",
  "parameter": "order_by",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/connectors",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/connectors",
  "parameter": "starting_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/connectors/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "starting_at",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "bucket_width",
  "location": "query",
  "type": "\"1d\" or \"1h\" or \"1m\"",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1d",
   "1h",
   "1m"
  ],
  "description": "Time bucket granularity.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "claude_tag_categories",
  "location": "query",
  "type": "array of \"dm\" or \"engaged\" or \"monitoring\" or 2 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "dm",
   "engaged",
   "monitoring",
   "proactive",
   "scheduled"
  ],
  "description": "Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "claude_tag_user_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "context_windows",
  "location": "query",
  "type": "array of \"0-200k\" or \"200k-1M\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "0-200k",
   "200k-1M"
  ],
  "description": "Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "ending_at",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"claude_tag_category\" or \"claude_tag_user_id\" or \"context_window\" or 8 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "claude_tag_category",
   "claude_tag_user_id",
   "context_window",
   "cost_type",
   "inference_geo",
   "model",
   "product",
   "rbac_group_id",
   "slack_channel_id",
   "speed",
   "token_type"
  ],
  "description": "Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "inference_geos",
  "location": "query",
  "type": "array of \"global\" or \"not_available\" or \"us\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "global",
   "not_available",
   "us"
  ],
  "description": "Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "models",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "products",
  "location": "query",
  "type": "array of \"chat\" or \"claude-tag\" or \"claude_code\" or 4 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "chat",
   "claude-tag",
   "claude_code",
   "claude_design",
   "claude_in_chrome",
   "cowork",
   "office_agent"
  ],
  "description": "Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "rbac_group_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "slack_channel_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "speeds",
  "location": "query",
  "type": "array of \"fast\" or \"standard\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "fast",
   "standard"
  ],
  "description": "Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/cost_report",
  "parameter": "user_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to specific users by tagged user ID.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/plugins",
  "parameter": "date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. The day to get plugin usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/plugins",
  "parameter": "ending_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/plugins",
  "parameter": "filter",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `plugin_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `plugin_name` matches case-insensitively; `product` is `claude_code` or `cowork` (the only surfaces with plugin attribution); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/plugins",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"product\" or \"rbac_group_id\" or \"user_id\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "product",
   "rbac_group_id",
   "user_id"
  ],
  "description": "Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. On this endpoint `product` takes the values `claude_code` or `cowork` only (the surfaces with plugin attribution). Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/plugins",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of results per page (1-1000, default 100).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/plugins",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/plugins",
  "parameter": "order_by",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/plugins",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/plugins",
  "parameter": "starting_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/plugins/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/skills",
  "parameter": "date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. The day to get skill usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/skills",
  "parameter": "ending_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/skills",
  "parameter": "filter",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `product`, `rbac_group_id`, `share_status`, `skill_name`, `user_id`. Value forms: `product` is one of `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `share_status` is one of `organization`, `private`, or `public`; `skill_name` matches case-insensitively; `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/skills",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"product\" or \"rbac_group_id\" or \"user_id\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "product",
   "rbac_group_id",
   "user_id"
  ],
  "description": "Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/skills",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of results per page (1-1000, default 100).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/skills",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/skills",
  "parameter": "order_by",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/skills",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/skills",
  "parameter": "starting_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/skills/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/summaries",
  "parameter": "starting_date",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. Start of the date range (inclusive). Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/retrieve_summaries",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/summaries",
  "parameter": "ending_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is typically available with a 1-day lag, so this can be at most today — which is also the default when omitted, making the last entry cover the most recent available day. Data may be revised by a few percent over the following days. The range may span at most 366 days.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/retrieve_summaries",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/summaries",
  "parameter": "filter",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filters as `dimension:value`. Only `rbac_group_id` is supported (e.g. `filter[]=rbac_group_id:{id}`); repeat the param to OR across groups. Scopes the whole day series to members of the matching group(s), re-aggregated from member-level activity — org-wide seat/invite fields and the adoption rates derived from them are null on scoped rows. `rbac_group_id` accepts the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each UTC day (time-of-usage attribution). At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/retrieve_summaries",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "starting_at",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "bucket_width",
  "location": "query",
  "type": "\"1d\" or \"1h\" or \"1m\"",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1d",
   "1h",
   "1m"
  ],
  "description": "Time bucket granularity.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "claude_tag_categories",
  "location": "query",
  "type": "array of \"dm\" or \"engaged\" or \"monitoring\" or 2 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "dm",
   "engaged",
   "monitoring",
   "proactive",
   "scheduled"
  ],
  "description": "Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "claude_tag_user_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "context_windows",
  "location": "query",
  "type": "array of \"0-200k\" or \"200k-1M\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "0-200k",
   "200k-1M"
  ],
  "description": "Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "ending_at",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"claude_tag_category\" or \"claude_tag_user_id\" or \"context_window\" or 6 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "claude_tag_category",
   "claude_tag_user_id",
   "context_window",
   "inference_geo",
   "model",
   "product",
   "rbac_group_id",
   "slack_channel_id",
   "speed"
  ],
  "description": "Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "inference_geos",
  "location": "query",
  "type": "array of \"global\" or \"not_available\" or \"us\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "global",
   "not_available",
   "us"
  ],
  "description": "Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "models",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "products",
  "location": "query",
  "type": "array of \"chat\" or \"claude-tag\" or \"claude_code\" or 4 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "chat",
   "claude-tag",
   "claude_code",
   "claude_design",
   "claude_in_chrome",
   "cowork",
   "office_agent"
  ],
  "description": "Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "rbac_group_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "slack_channel_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "speeds",
  "location": "query",
  "type": "array of \"fast\" or \"standard\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "fast",
   "standard"
  ],
  "description": "Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/usage_report",
  "parameter": "user_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to specific users by tagged user ID.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "starting_at",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "bucket_width",
  "location": "query",
  "type": "\"1d\" or \"1h\" or \"1m\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1d",
   "1h",
   "1m"
  ],
  "description": "Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width=\"1m\"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "claude_tag_categories",
  "location": "query",
  "type": "array of \"dm\" or \"engaged\" or \"monitoring\" or 2 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "dm",
   "engaged",
   "monitoring",
   "proactive",
   "scheduled"
  ],
  "description": "Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "claude_tag_user_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "context_windows",
  "location": "query",
  "type": "array of \"0-200k\" or \"200k-1M\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "0-200k",
   "200k-1M"
  ],
  "description": "Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "ending_at",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "exclude_deleted_users",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"claude_tag_category\" or \"claude_tag_user_id\" or \"context_window\" or 8 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "claude_tag_category",
   "claude_tag_user_id",
   "context_window",
   "cost_type",
   "inference_geo",
   "model",
   "product",
   "rbac_group_id",
   "slack_channel_id",
   "speed",
   "token_type"
  ],
  "description": "Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/cost_report` endpoint. The `product`, `model`, `context_window`, `inference_geo`, and `speed` dimensions — and the time bucket, when `bucket_width` is set — count toward `limit`. `cost_type` and `token_type` do not: `cost_type` returns one row per cost component (tokens, web search, code execution); `token_type` returns one row per token type, each with `cost_type: \"tokens\"`; combining both returns the per-token-type rows plus the web-search and code-execution rows. A page can therefore contain more rows than `limit` when `cost_type` or `token_type` is requested.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "inference_geos",
  "location": "query",
  "type": "array of \"global\" or \"not_available\" or \"us\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "global",
   "not_available",
   "us"
  ],
  "description": "Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "models",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "order_by",
  "location": "query",
  "type": "\"amount\" or \"list_amount\"",
  "required": false,
  "default": "amount",
  "minimum": null,
  "maximum": null,
  "enum": [
   "amount",
   "list_amount"
  ],
  "description": "Metric to rank actors by. Defaults to `amount`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "products",
  "location": "query",
  "type": "array of \"chat\" or \"claude-tag\" or \"claude_code\" or 4 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "chat",
   "claude-tag",
   "claude_code",
   "claude_design",
   "claude_in_chrome",
   "cowork",
   "office_agent"
  ],
  "description": "Product surfaces to include. Defaults to all products.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "rbac_group_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "slack_channel_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "speeds",
  "location": "query",
  "type": "array of \"fast\" or \"standard\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "fast",
   "standard"
  ],
  "description": "Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_cost_report",
  "parameter": "user_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to specific users by tagged user ID.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "starting_at",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "bucket_width",
  "location": "query",
  "type": "\"1d\" or \"1h\" or \"1m\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1d",
   "1h",
   "1m"
  ],
  "description": "Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width=\"1m\"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "claude_tag_categories",
  "location": "query",
  "type": "array of \"dm\" or \"engaged\" or \"monitoring\" or 2 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "dm",
   "engaged",
   "monitoring",
   "proactive",
   "scheduled"
  ],
  "description": "Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "claude_tag_user_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "context_windows",
  "location": "query",
  "type": "array of \"0-200k\" or \"200k-1M\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "0-200k",
   "200k-1M"
  ],
  "description": "Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "ending_at",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "exclude_deleted_users",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"claude_tag_category\" or \"claude_tag_user_id\" or \"context_window\" or 6 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "claude_tag_category",
   "claude_tag_user_id",
   "context_window",
   "inference_geo",
   "model",
   "product",
   "rbac_group_id",
   "slack_channel_id",
   "speed"
  ],
  "description": "Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/usage_report` endpoint. `limit` bounds (actor × time bucket × dimension) rows — with dimensions or `bucket_width` present, one actor may span several rows.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "inference_geos",
  "location": "query",
  "type": "array of \"global\" or \"not_available\" or \"us\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "global",
   "not_available",
   "us"
  ],
  "description": "Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "models",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "order_by",
  "location": "query",
  "type": "\"output_tokens\" or \"requests\" or \"total_tokens\" or \"uncached_input_tokens\"",
  "required": false,
  "default": "total_tokens",
  "minimum": null,
  "maximum": null,
  "enum": [
   "output_tokens",
   "requests",
   "total_tokens",
   "uncached_input_tokens"
  ],
  "description": "Metric to rank actors by. Defaults to `total_tokens`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "products",
  "location": "query",
  "type": "array of \"chat\" or \"claude-tag\" or \"claude_code\" or 4 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "chat",
   "claude-tag",
   "claude_code",
   "claude_design",
   "claude_in_chrome",
   "cowork",
   "office_agent"
  ],
  "description": "Product surfaces to include. Defaults to all products.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "rbac_group_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "slack_channel_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "speeds",
  "location": "query",
  "type": "array of \"fast\" or \"standard\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "fast",
   "standard"
  ],
  "description": "Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/user_usage_report",
  "parameter": "user_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to specific users by tagged user ID.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list_by_user",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/users",
  "parameter": "date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. The day to get user activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/users",
  "parameter": "ending_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/users",
  "parameter": "filter",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`) and scopes each member's row to their claude.ai chat activity within that project (it cannot be combined with `group_by[]` or an `rbac_group_id` filter); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/users",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"rbac_group_id\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Dimensions to break results out by (e.g. `group_by[]=rbac_group_id`). Supported on this endpoint: `rbac_group_id`. Rows are already per-member, so the one supported grouping aggregates them per RBAC group instead. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/users",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of results per page (1-1000, default 100).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/users",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/users",
  "parameter": "order_by",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/users",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/analytics/users",
  "parameter": "starting_date",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/analytics/users/list",
  "constraints": {
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/api_keys",
  "parameter": "after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/api_keys",
  "parameter": "before_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/api_keys",
  "parameter": "created_by_user_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by the ID of the User who created the object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/api_keys",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/api_keys",
  "parameter": "status",
  "location": "query",
  "type": "\"active\" or \"archived\" or \"expired\" or \"inactive\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "active",
   "archived",
   "expired",
   "inactive"
  ],
  "description": "Filter by API key status.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/api_keys",
  "parameter": "workspace_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by Workspace ID.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/api_keys/{api_key_id}",
  "parameter": "api_key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the API key.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/api_keys/{api_key_id}",
  "parameter": "api_key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the API key.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/api_keys/{api_key_id}",
  "parameter": "name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the API key.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/update",
  "constraints": {
   "maxLength": "500",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/api_keys/{api_key_id}",
  "parameter": "status",
  "location": "body",
  "type": "\"active\" or \"archived\" or \"inactive\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "active",
   "archived",
   "inactive"
  ],
  "description": "Status of the API key.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/api_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/compliance_settings",
  "parameter": "state",
  "location": "body",
  "type": "BetaComplianceSettingsStateParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Desired state. Accepts the string shorthand \"enabled\" or \"disabled\" in place of the object form; the response always returns the canonical object form.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings/update",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/compliance_settings",
  "parameter": "state.type",
  "location": "body",
  "type": "\"enabled\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/compliance_settings",
  "parameter": "state.type",
  "location": "body",
  "type": "\"disabled\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/cost_report",
  "parameter": "starting_at",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Time buckets that start on or after this RFC 3339 timestamp will be returned. Each time bucket will be snapped to the start of the minute/hour/day in UTC.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/cost_report/retrieve",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/cost_report",
  "parameter": "bucket_width",
  "location": "query",
  "type": "\"1d\"",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Time granularity of the response data.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/cost_report/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/cost_report",
  "parameter": "ending_at",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Time buckets that end before this RFC 3339 timestamp will be returned.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/cost_report/retrieve",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/cost_report",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"description\" or \"workspace_id\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "description",
   "workspace_id"
  ],
  "description": "Group by any subset of the available options.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/cost_report/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/cost_report",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "7",
  "minimum": 1,
  "maximum": 31,
  "enum": null,
  "description": "Maximum number of time buckets to return in the response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/cost_report/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/cost_report",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optionally set to the `next_page` token from the previous response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/cost_report/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/external_keys",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Number of results per page.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/external_keys",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config",
  "location": "body",
  "type": "BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "KMS provider identity and auth coordinates.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.type",
  "location": "body",
  "type": "\"aws\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.kms_arn",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.region",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "AWS region. Derived from `kms_arn` if omitted.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.role_arn",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "**Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.type",
  "location": "body",
  "type": "\"gcp\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.key_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the key within the vault.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.type",
  "location": "body",
  "type": "\"azure\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.tenant_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Azure AD tenant ID.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.vault_uri",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "provider_config.client_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "display_name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-friendly display name.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys",
  "parameter": "geo",
  "location": "body",
  "type": "\"us\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Data residency geo. Only `us` is supported.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/external_keys/{external_key_id}",
  "parameter": "external_key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the External Key.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/delete",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/external_keys/{external_key_id}",
  "parameter": "external_key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the External Key.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/retrieve",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "external_key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the External Key.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "display_name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-friendly display name.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "geo",
  "location": "body",
  "type": "\"us\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Data residency geo. Only `us` is supported.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config",
  "location": "body",
  "type": "BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "KMS provider identity and auth coordinates.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.type",
  "location": "body",
  "type": "\"aws\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.kms_arn",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.region",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "AWS region. Derived from `kms_arn` if omitted.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.role_arn",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "**Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.type",
  "location": "body",
  "type": "\"gcp\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.key_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the key within the vault.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.type",
  "location": "body",
  "type": "\"azure\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.tenant_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Azure AD tenant ID.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.vault_uri",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}",
  "parameter": "provider_config.client_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/external_keys/{external_key_id}/validate",
  "parameter": "external_key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the External Key.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/external_keys/validate",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_issuers",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Include archived resources. Defaults to false.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_issuers",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Number of results per page.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_issuers",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "issuer_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The `iss` claim value to match against.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "check_jti",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "jwks",
  "location": "body",
  "type": "BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "How signing keys are obtained. Defaults to OIDC discovery.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "jwks.type",
  "location": "body",
  "type": "\"discovery\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "jwks.ca_cert_pem",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional custom CA (PEM) for TLS verification of the JWKS fetch.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "constraints": {
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "jwks.discovery_base",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Set when the discovery URL differs from `issuer_url`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "jwks.type",
  "location": "body",
  "type": "\"explicit_url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "jwks.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JWKS endpoint.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "jwks.type",
  "location": "body",
  "type": "\"inline\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "jwks.keys",
  "location": "body",
  "type": "array of map[unknown]",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline JWK objects.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "constraints": {
   "minItems": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers",
  "parameter": "max_jwt_lifetime_seconds",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. maximum: 176400, exclusiveMinimum: 0",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "federation_issuer_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the federation issuer.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "federation_issuer_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the federation issuer to update.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "check_jti",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "issuer_url",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "jwks",
  "location": "body",
  "type": "BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the entire JWKS configuration.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "jwks.type",
  "location": "body",
  "type": "\"discovery\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "jwks.ca_cert_pem",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional custom CA (PEM) for TLS verification of the JWKS fetch.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "constraints": {
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "jwks.discovery_base",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Set when the discovery URL differs from `issuer_url`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "jwks.type",
  "location": "body",
  "type": "\"explicit_url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "jwks.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JWKS endpoint.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "jwks.type",
  "location": "body",
  "type": "\"inline\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "jwks.keys",
  "location": "body",
  "type": "array of map[unknown]",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline JWK objects.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "constraints": {
   "minItems": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "jwks_polling_disabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "max_jwt_lifetime_seconds",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. maximum: 176400, exclusiveMinimum: 0",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}",
  "parameter": "name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/update",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_issuers/{federation_issuer_id}/archive",
  "parameter": "federation_issuer_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the federation issuer to archive.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/issuers/archive",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_rules",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Include archived resources. Defaults to false.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_rules",
  "parameter": "issuer_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to rules referencing this federation issuer.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_rules",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Number of results per page.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_rules",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "issuer_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the federation issuer.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "match",
  "location": "body",
  "type": "BetaFederationRuleMatch",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "match.audience",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "match.claims",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "match.condition",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "constraints": {
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "match.subject_prefix",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "oauth_scope",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "target",
  "location": "body",
  "type": "BetaServiceAccountTarget",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identity that tokens minted via this rule act as. Currently always a `service_account` target.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "target.type",
  "location": "body",
  "type": "\"service_account\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "target.service_account_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the service account to mint tokens for.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "target.service_account_name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Service account's display name at read time. Ignored on writes.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "applies_to_all_workspaces",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, enable this rule for every workspace in the org (including workspaces created later).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "attributes",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional free-text description.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "constraints": {
   "maxLength": "2000"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "token_lifetime_seconds",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 60,
  "maximum": 86400,
  "enum": null,
  "description": "Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules",
  "parameter": "workspace_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "federation_rule_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the federation rule.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "federation_rule_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the federation rule to update.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "applies_to_all_workspaces",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "attributes",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "constraints": {
   "maxLength": "2000"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "match",
  "location": "body",
  "type": "BetaFederationRuleMatch or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Does the incoming JWT qualify? All populated fields must pass; omitted fields are skipped. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "match.audience",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "match.claims",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "match.condition",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "constraints": {
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "match.subject_prefix",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "oauth_scope",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "target",
  "location": "body",
  "type": "BetaServiceAccountTarget or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Bind to a fixed service account by ID.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "target.type",
  "location": "body",
  "type": "\"service_account\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "target.service_account_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the service account to mint tokens for.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "target.service_account_name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Service account's display name at read time. Ignored on writes.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "token_lifetime_seconds",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": 60,
  "maximum": 86400,
  "enum": null,
  "description": "Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}",
  "parameter": "workspace_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}/archive",
  "parameter": "federation_rule_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the federation rule to archive.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/archive",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_rules/{federation_rule_id}/workspaces",
  "parameter": "federation_rule_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the federation rule.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_rules/{federation_rule_id}/workspaces",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Number of results per page.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/federation_rules/{federation_rule_id}/workspaces",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}/workspaces",
  "parameter": "federation_rule_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the federation rule.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/federation_rules/{federation_rule_id}/workspaces",
  "parameter": "workspace_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the workspace to enable this rule for.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}",
  "parameter": "federation_rule_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the federation rule.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/remove",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the workspace to disable for.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/federation/rules/workspaces/remove",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/invites",
  "parameter": "after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/invites",
  "parameter": "before_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/invites",
  "parameter": "email",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/list",
  "constraints": {
   "format": "email"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/invites",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/invites",
  "parameter": "roles",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/invites",
  "parameter": "statuses",
  "location": "query",
  "type": "array of \"accepted\" or \"expired\" or \"pending\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "accepted",
   "expired",
   "pending"
  ],
  "description": "Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/invites",
  "parameter": "email",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/create",
  "constraints": {
   "format": "email"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/invites",
  "parameter": "role",
  "location": "body",
  "type": "\"billing\" or \"claude_code_user\" or \"developer\" or 2 more",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "billing",
   "claude_code_user",
   "developer",
   "managed",
   "user"
  ],
  "description": "Role for the invited User. The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/invites",
  "parameter": "rbac_group_ids",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/create",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/invites/{invite_id}",
  "parameter": "invite_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Invite.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/delete",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/invites/{invite_id}",
  "parameter": "invite_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Invite.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/invites/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rate_limits",
  "parameter": "group_type",
  "location": "query",
  "type": "\"batch\" or \"files\" or \"model_group\" or 3 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "batch",
   "files",
   "model_group",
   "skills",
   "token_count",
   "web_search"
  ],
  "description": "Filter by group type.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rate_limits",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum number of items to return per page. Ranges from `1` to `1000`. When omitted, every remaining entry is returned in a single page and `next_page` is `null`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rate_limits",
  "parameter": "model",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rate_limits",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rate_limits/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_groups",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_groups",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optionally set to the `next_page` token from the previous response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/rbac_groups",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the RBAC Group. Not uniqueness-enforced.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/create",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/rbac_groups/{group_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the RBAC Group.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/delete",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_groups/{group_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the RBAC Group.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/rbac_groups/{group_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the RBAC Group.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/rbac_groups/{group_id}",
  "parameter": "name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the RBAC Group. Not uniqueness-enforced.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/update",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_groups/{group_id}/members",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the RBAC Group.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_groups/{group_id}/members",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_groups/{group_id}/members",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optionally set to the `next_page` token from the previous response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/rbac_groups/{group_id}/members",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the RBAC Group.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/rbac_groups/{group_id}/members",
  "parameter": "user_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/rbac_groups/{group_id}/members/{user_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the RBAC Group.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/delete",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/rbac_groups/{group_id}/members/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/delete",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_roles",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_roles",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optionally set to the `next_page` token from the previous response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the RBAC Role.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_roles/{role_id}/permissions",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the RBAC Role.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/permissions/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_roles/{role_id}/permissions",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/permissions/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/rbac_roles/{role_id}/permissions",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optionally set to the `next_page` token from the previous response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/rbac_roles/permissions/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/service_accounts",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Include archived resources. Defaults to false.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/service_accounts",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Number of results per page.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/service_accounts",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/create",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional free-text description.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/create",
  "constraints": {
   "maxLength": "2000"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts",
  "parameter": "organization_role",
  "location": "body",
  "type": "\"admin\" or \"developer\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "admin",
   "developer"
  ],
  "description": "Org-level role. Defaults to `developer`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/service_accounts/{service_account_id}",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the service account.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts/{service_account_id}",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the service account to update.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts/{service_account_id}",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/update",
  "constraints": {
   "maxLength": "2000"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts/{service_account_id}",
  "parameter": "organization_role",
  "location": "body",
  "type": "\"admin\" or \"developer\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "admin",
   "developer"
  ],
  "description": "Replaces the org-level role. Omit or send `null` to leave unchanged.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts/{service_account_id}/archive",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the service account to archive.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/archive",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/service_accounts/{service_account_id}/workspaces",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the service account.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/service_accounts/{service_account_id}/workspaces",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Number of results per page.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/service_accounts/{service_account_id}/workspaces",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts/{service_account_id}/workspaces",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the service account.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts/{service_account_id}/workspaces",
  "parameter": "workspace_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged workspace ID to add the service account to.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/service_accounts/{service_account_id}/workspaces",
  "parameter": "workspace_role",
  "location": "body",
  "type": "BetaNoBillingWorkspaceRole",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "workspace_admin",
   "workspace_developer",
   "workspace_restricted_developer",
   "workspace_user"
  ],
  "description": "Role to assign to the service account in this workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the service account.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/remove",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/service_accounts/workspaces/remove",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limit_increase_requests",
  "parameter": "actor_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by requester, as `user_...` tagged IDs.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limit_increase_requests",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limit_increase_requests",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limit_increase_requests",
  "parameter": "status",
  "location": "query",
  "type": "array of \"approved\" or \"denied\" or \"pending\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "approved",
   "denied",
   "pending"
  ],
  "description": "Filter by status. Omit to return all.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}",
  "parameter": "spend_limit_increase_request_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the spend limit increase request.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve",
  "parameter": "spend_limit_increase_request_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the spend limit increase request.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/approve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve",
  "parameter": "amount",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New per-user spend limit as a non-negative integer decimal string (minor units).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/approve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve",
  "parameter": "period",
  "location": "body",
  "type": "\"daily\" or \"monthly\" or \"weekly\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "daily",
   "monthly",
   "weekly"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/approve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve",
  "parameter": "suppress_notification",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/approve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny",
  "parameter": "spend_limit_increase_request_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the spend limit increase request.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/deny",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny",
  "parameter": "suppress_notification",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests/deny",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limits",
  "parameter": "amount",
  "location": "body",
  "type": "string or null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Limit amount as a non-negative integer decimal string in the minor unit of the organization's billing currency (cents for USD): \"50000\" is $500.00. `null` sets an explicit no-limit override for this scope and `period` only — each period resolves independently, so caps for other periods still apply.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limits",
  "parameter": "scope",
  "location": "body",
  "type": "User or Organization or Workspace",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "What the limit applies to. Claude Enterprise organizations set `user` limits. Claude Console organizations set `organization` and `workspace` limits. Any other combination returns 400. Setting `organization` and `workspace` limits through the API is in an early access preview. To request access, contact your Anthropic account team.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limits",
  "parameter": "scope.type",
  "location": "body",
  "type": "\"user\"",
  "required": true,
  "default": "user",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Scope type. Always `user` for this scope.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limits",
  "parameter": "scope.user_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the member the spend limit applies to.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limits",
  "parameter": "scope.type",
  "location": "body",
  "type": "\"organization\"",
  "required": true,
  "default": "organization",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limits",
  "parameter": "scope.type",
  "location": "body",
  "type": "\"workspace\"",
  "required": true,
  "default": "workspace",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Scope type. Always `workspace` for this scope.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limits",
  "parameter": "scope.workspace_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the workspace the spend limit applies to.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/spend_limits",
  "parameter": "period",
  "location": "body",
  "type": "\"daily\" or \"monthly\" or \"weekly\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "daily",
   "monthly",
   "weekly"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limits/effective",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum number of members per page. A member's period rows never split across pages, so a page may carry more rows than this. Defaults to `20`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/list_effective",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limits/effective",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/list_effective",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limits/effective",
  "parameter": "period",
  "location": "query",
  "type": "array of \"daily\" or \"monthly\" or \"weekly\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "daily",
   "monthly",
   "weekly"
  ],
  "description": "Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/list_effective",
  "constraints": {
   "maxItems": "3"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limits/effective",
  "parameter": "user_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Restrict the report to these members, by tagged user ID (`user_...`). At most 100 entries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/list_effective",
  "constraints": {
   "maxItems": "100"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/spend_limits/{spend_limit_id}",
  "parameter": "spend_limit_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Spend Limit.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/delete",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/spend_limits/{spend_limit_id}",
  "parameter": "spend_limit_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Spend Limit.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/spend_limits/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Include archived tunnels in the results. Archived tunnels are excluded by default.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum number of tunnels to return in a single page.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor from a previous response's `next_page`. Omit to fetch the first page.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels",
  "parameter": "workspace_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only tunnels in this Workspace. Accepts a `wrkspc_`-prefixed Workspace ID; omit to list tunnels across all Workspaces.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels/{tunnel_id}",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/tunnels/{tunnel_id}/archive",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/archive",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels/{tunnel_id}/certificates",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels/{tunnel_id}/certificates",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Include archived certificates in the results. Archived certificates are excluded by default.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels/{tunnel_id}/certificates",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum number of certificates to return.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels/{tunnel_id}/certificates",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tunnel has at most two active certificates, so this list is not paginated.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/tunnels/{tunnel_id}/certificates",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/tunnels/{tunnel_id}/certificates",
  "parameter": "ca_certificate_pem",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/create",
  "constraints": {
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}",
  "parameter": "certificate_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel Certificate.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/archive",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive",
  "parameter": "certificate_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel Certificate.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/tunnel_certificates/archive",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/tunnels/{tunnel_id}/reveal_token",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/reveal_token",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/tunnels/{tunnel_id}/rotate_token",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Tunnel.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/rotate_token",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/tunnels/{tunnel_id}/rotate_token",
  "parameter": "reason",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional free-text reason for the rotation, recorded for audit.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-05-19",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/mcp_tunnels/rotate_token",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/claude_code",
  "parameter": "starting_at",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTC date in YYYY-MM-DD format. Returns metrics for this single day only.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_claude_code",
  "constraints": {
   "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
   "format": "date"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/claude_code",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of records per page (default: 20, max: 1000).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_claude_code",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/claude_code",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor token from previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_claude_code",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "starting_at",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Time buckets that start on or after this RFC 3339 timestamp will be returned. Each time bucket will be snapped to the start of the minute/hour/day in UTC.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "account_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Restrict usage returned to the specified user account ID(s).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Restrict usage returned to the specified API key ID(s).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "bucket_width",
  "location": "query",
  "type": "\"1d\" or \"1h\" or \"1m\"",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1d",
   "1h",
   "1m"
  ],
  "description": "Time granularity of the response data.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "context_window",
  "location": "query",
  "type": "array of \"0-200k\" or \"200k-1M\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "0-200k",
   "200k-1M"
  ],
  "description": "Restrict usage returned to the specified context window(s).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "ending_at",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Time buckets that end before this RFC 3339 timestamp will be returned.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "group_by",
  "location": "query",
  "type": "array of \"account_id\" or \"api_key_id\" or \"context_window\" or 6 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "account_id",
   "api_key_id",
   "context_window",
   "inference_geo",
   "model",
   "service_account_id",
   "service_tier",
   "speed",
   "workspace_id"
  ],
  "description": "Group by any subset of the available options. Grouping by `speed` requires the `fast-mode-2026-02-01` beta header.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "inference_geos",
  "location": "query",
  "type": "array of \"global\" or \"not_available\" or \"us\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "global",
   "not_available",
   "us"
  ],
  "description": "Restrict usage returned to the specified inference geo(s). Use `not_available` for models that do not support specifying `inference_geo`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of time buckets to return in the response. The default and max limits depend on `bucket_width`: • `\"1d\"`: Default of 7 days, maximum of 31 days • `\"1h\"`: Default of 24 hours, maximum of 168 hours • `\"1m\"`: Default of 60 minutes, maximum of 1440 minutes",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "models",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Restrict usage returned to the specified model(s).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optionally set to the `next_page` token from the previous response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "service_account_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Restrict usage returned to the specified service account ID(s).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "service_tiers",
  "location": "query",
  "type": "array of \"batch\" or \"flex\" or \"flex_discount\" or 3 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "batch",
   "flex",
   "flex_discount",
   "priority",
   "priority_on_demand",
   "standard"
  ],
  "description": "Restrict usage returned to the specified service tier(s).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "speeds",
  "location": "query",
  "type": "array of \"standard\" or \"fast\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "standard",
   "fast"
  ],
  "description": "Restrict usage returned to the specified speed(s) (Claude Code research preview). Requires the `fast-mode-2026-02-01` beta header.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/usage_report/messages",
  "parameter": "workspace_ids",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Restrict usage returned to the specified workspace ID(s).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/usage_report/retrieve_messages",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/users",
  "parameter": "after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/users",
  "parameter": "before_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/users",
  "parameter": "email",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by user email.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/users/list",
  "constraints": {
   "format": "email"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/users",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/users",
  "parameter": "roles",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/users/remove",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/users/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/users/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/users/{user_id}",
  "parameter": "role",
  "location": "body",
  "type": "\"billing\" or \"claude_code_user\" or \"developer\" or 2 more",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "billing",
   "claude_code_user",
   "developer",
   "managed",
   "user"
  ],
  "description": "New role for the User. The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/users/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces",
  "parameter": "after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces",
  "parameter": "before_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to include Workspaces that have been archived in the response",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the Workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create",
  "constraints": {
   "maxLength": "40",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces",
  "parameter": "data_residency",
  "location": "body",
  "type": "BetaDataResidencyCreateConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: \"us\"`, `allowed_inference_geos: \"unrestricted\"`, and `default_inference_geo: \"global\"`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces",
  "parameter": "data_residency.allowed_inference_geos",
  "location": "body",
  "type": "array of BetaAllowedInferenceGeo or \"unrestricted\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces",
  "parameter": "data_residency.default_inference_geo",
  "location": "body",
  "type": "\"global\" or \"us\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "global",
   "us"
  ],
  "description": "Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `\"unrestricted\"`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces",
  "parameter": "data_residency.workspace_geo",
  "location": "body",
  "type": "\"us\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces",
  "parameter": "display_color",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Hex color code representing the Workspace in the Anthropic Console.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create",
  "constraints": {
   "maxLength": "7",
   "pattern": "^#[0-9A-Fa-f]{6}$"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces",
  "parameter": "external_key_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces",
  "parameter": "tags",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/create",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}",
  "parameter": "data_residency",
  "location": "body",
  "type": "BetaDataResidencyUpdateConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Data residency configuration for the workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}",
  "parameter": "data_residency.allowed_inference_geos",
  "location": "body",
  "type": "array of BetaAllowedInferenceGeo or \"unrestricted\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}",
  "parameter": "data_residency.default_inference_geo",
  "location": "body",
  "type": "\"global\" or \"us\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "global",
   "us"
  ],
  "description": "Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `\"unrestricted\"`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}",
  "parameter": "display_color",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Hex color code representing the Workspace in the Anthropic Console.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update",
  "constraints": {
   "maxLength": "7",
   "pattern": "^#[0-9A-Fa-f]{6}$"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}",
  "parameter": "external_key_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the Workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update",
  "constraints": {
   "maxLength": "40",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}",
  "parameter": "tags",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/archive",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/archive",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/members",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/members",
  "parameter": "after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/members",
  "parameter": "before_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/members",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/members",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/members",
  "parameter": "user_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/members",
  "parameter": "workspace_role",
  "location": "body",
  "type": "BetaNoBillingWorkspaceRole",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "workspace_admin",
   "workspace_developer",
   "workspace_restricted_developer",
   "workspace_user"
  ],
  "description": "Role of the new Workspace Member. Cannot be `workspace_billing`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/workspaces/{workspace_id}/members/{user_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/remove",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/workspaces/{workspace_id}/members/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/remove",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/members/{user_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/members/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/members/{user_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/members/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/members/{user_id}",
  "parameter": "workspace_role",
  "location": "body",
  "type": "BetaWorkspaceRole",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "workspace_admin",
   "workspace_billing",
   "workspace_developer",
   "workspace_restricted_developer",
   "workspace_user"
  ],
  "description": "New workspace role for the User.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/rate_limits",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/rate_limits",
  "parameter": "group_type",
  "location": "query",
  "type": "\"batch\" or \"files\" or \"model_group\" or 3 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "batch",
   "files",
   "model_group",
   "skills",
   "token_count",
   "web_search"
  ],
  "description": "Filter by group type.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/rate_limits",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum number of items to return per page. Ranges from `1` to `1000`. When omitted, every remaining entry is returned in a single page and `next_page` is `null`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/rate_limits",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/service_accounts",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/service_accounts",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Number of results per page.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/service_accounts",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/list",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/service_accounts",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/service_accounts",
  "parameter": "service_account_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged service account ID to add.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/service_accounts",
  "parameter": "workspace_role",
  "location": "body",
  "type": "BetaNoBillingWorkspaceRole",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "workspace_admin",
   "workspace_developer",
   "workspace_restricted_developer",
   "workspace_user"
  ],
  "description": "Role to assign to the service account in this workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/add",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/remove",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the service account.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/remove",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the service account.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}",
  "parameter": "workspace_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the service account.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}",
  "parameter": "workspace_role",
  "location": "body",
  "type": "BetaNoBillingWorkspaceRole",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "workspace_admin",
   "workspace_developer",
   "workspace_restricted_developer",
   "workspace_user"
  ],
  "description": "New role for the service account in this workspace.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/update",
  "_fragment": "generated/fragments/parameters/anthropic-admin.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "cache_control",
  "location": "body",
  "type": "object (CacheControlEphemeral) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Top-level automatic caching: the API places one cache breakpoint on the last cacheable block and moves it forward as the conversation grows. Uses one of the 4 breakpoint slots. 400 if the last block already carries an explicit cache_control with a different TTL, or if 4 explicit breakpoints exist. Not accepted on legacy Bedrock (Opus 4.6 and earlier).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/prompt-caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "cache_03_auto_top_level: cache_read 5809 + cache_creation 7 on Haiku"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "cache_control.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "ephemeral"
  ],
  "description": "Cache type. Only 'ephemeral' exists.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/prompt-caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "cache_control.ttl",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "5m",
  "minimum": null,
  "maximum": null,
  "enum": [
   "5m",
   "1h"
  ],
  "description": "Cache lifetime. 5m (default, 1.25x input price on write) or 1h (2x on write). Longer-TTL breakpoints must precede shorter ones in the prompt.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/prompt-caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "cache_04: ephemeral_1h_input_tokens=5809; ttl '2h' -> 400 \"Input should be '5m' or '1h'\""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "system[].cache_control",
  "location": "body",
  "type": "object (CacheControlEphemeral) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Explicit breakpoint on a system text block. Caches tools + system up to and including this block.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/prompt-caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "cache_01/02: creation 5809 then read 5809"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].cache_control",
  "location": "body",
  "type": "object (CacheControlEphemeral) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Explicit breakpoint on a tool definition; caches all tools up to and including it.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/prompt-caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "cache_06/07: creation 7484 then read 7484"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].cache_control",
  "location": "body",
  "type": "object (CacheControlEphemeral) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Explicit breakpoint on a content block (text, image, document, tool_use, tool_result, search_result, compaction). Max 4 breakpoints per request (400 'A maximum of 4 blocks with cache_control may be provided'). Not allowed on thinking blocks, sub-blocks (citations) or empty text blocks. NOT accepted at message level (messages[].cache_control -> 400 'Extra inputs are not permitted').",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/prompt-caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "failure",
   "http_status": 400,
   "request_note": "cache_10 five breakpoints -> 400; cache_11 message-level -> 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "max_tokens",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": [],
  "description": "Max output tokens. Required (missing → 400 'max_tokens: Field required'). Above the model max → 400 (Haiku 4.5: '1000000 > 64000'). `0` pre-warms the prompt cache without sampling (live: stop_reason max_tokens, empty content, output_tokens 0).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "diagnostics",
  "location": "body",
  "type": "object (BetaDiagnosticsParam) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cache diagnostics (beta): pass the previous response id so the API reports where the prompt prefix diverged in response.diagnostics.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "cache-diagnosis-2026-04-07",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "cache_12: diagnostics.previous_message_id=null accepted, response diagnostics=null"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "diagnostics.previous_message_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 256,
  "enum": null,
  "description": "msg_… id of this client's previous response; null on the first turn to opt in.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "cache-diagnosis-2026-04-07",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking",
  "location": "body",
  "type": "object (ThinkingConfigParam)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Thinking configuration. Variants: {type:'enabled', budget_tokens, display}, {type:'adaptive', display}, {type:'disabled'}. Per-model acceptance differs (see compatibility matrix). Omitting it means: on/always-on for 5.x & Fable, off for Opus 4.6-4.8/Sonnet 4.6 and all 4.5 models.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "enabled",
   "disabled",
   "adaptive"
  ],
  "description": "`enabled` (extended thinking with budget; Claude ≤ 4.6 and Mythos Preview), `adaptive` (Claude 4.6+; 4.5 models reject it: 'adaptive thinking is not supported on this model'), `disabled` (rejected on Fable 5.x / Mythos 5.x / Mythos Preview where thinking is always on).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking.budget_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1024,
  "maximum": null,
  "enum": [],
  "description": "Extended thinking budget (type=enabled). ≥1024 and < max_tokens; counts toward max_tokens.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking.display",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "model-specific (summarized <=4.6, omitted 4.7+)",
  "minimum": null,
  "maximum": null,
  "enum": [
   "summarized",
   "omitted",
   "updates"
  ],
  "description": "How thinking text is returned. summarized = summary text (default on <=4.6); omitted = empty thinking field, signature kept (default on 4.7+, 5.x, Fable/Mythos); updates (beta, header thinking-display-updates-2026-08-18) = progress-update blocks carry text, reasoning blocks empty. Invalid with type disabled. Billing identical for all values.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "think_08 omitted -> thinking:'' + signature; adaptive_05 'updates' without header -> 400; adaptive_06 with header -> 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking.block_binding",
  "location": "body",
  "type": "object (BetaThinkingBlockBinding) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Preserved-thinking controls (beta). Accepted with type adaptive or enabled. Without the beta header -> 400 'block_binding: Extra inputs are not permitted'.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "thinking-binding-controls-2026-08-01",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/preserved-thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "adaptive_07: accepted on Sonnet 5, response input_transformations=[]"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking.block_binding.prefix_mismatch_behavior",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "error",
  "minimum": null,
  "maximum": null,
  "enum": [
   "error",
   "drop_block"
  ],
  "description": "What happens when a replayed thinking block fails the conversation (prefix) check: error (default, 400 naming the block) or drop_block (drop it and later thinking blocks, report in input_transformations). Enforced by default only for accounts created on/after 2026-08-31 on Fable 5.1 / Mythos 5.1.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "thinking-binding-controls-2026-08-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/preserved-thinking",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1.0,
  "minimum": 0,
  "maximum": 1,
  "enum": [],
  "description": "Sampling randomness 0..1 (default 1.0). DEPRECATED: models after Opus 4.6 accept only 1.0. Live on Haiku 4.5: `temperature` and `top_p` together → 400 '`temperature` and `top_p` cannot both be specified for this model'; 5 → 400 'temperature: range: 0..1'.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "top_k",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": [],
  "description": "Top-K sampling (≥0). DEPRECATED: rejected (400) on models after Opus 4.6. Wrong type → 400 'top_k: Input should be a valid integer'.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "top_p",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": [],
  "description": "Nucleus sampling 0..1. DEPRECATED: models after Opus 4.6 accept only ≥0.99. Cannot be combined with temperature on current models (live 400).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tool_choice",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "How Claude uses tools: {type: auto|any|tool|none, name?, disable_parallel_tool_use?}. Default auto when tools present, none otherwise. any/tool unsupported with manual thinking and on Fable 5.1/Mythos 5.1 (400).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/define-tools",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[] (assistant prefill)",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Assistant prefill is documented as unsupported while thinking is on (400 on Opus 4.6+, Fable). OBSERVED on Haiku 4.5: prefill + thinking enabled returned 200 with thinking silently disabled (no thinking block, no output_tokens_details).",
  "compatible_models": [
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "think_14_prefill_conflict -> 200, no thinking block"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config",
  "location": "body",
  "type": "object (OutputConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Output configuration container: effort, format (structured outputs), task_budget (beta).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/effort",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "high",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "How much work Claude puts into the whole response (text, tool calls, thinking). Default high (explicit high == omitted, cache-neutral). xhigh/max availability per model. Rendered into the prompt: changing the top-level value invalidates message cache breakpoints (and tool/system on some models). 400 on unsupported models: 'This model does not support the effort parameter.' Invalid value -> 400 \"Input should be 'low', 'medium', 'high', 'xhigh' or 'max'\".",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/effort",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "effort low/xhigh/max on Sonnet 5 -> 200; 'ultra' -> 400; Haiku -> 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].output_config.effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "Per-message effort (beta): a {role:'system', content:[], output_config:{effort}} entry inside messages changes effort from the next user turn on without invalidating the cache. Only Fable 5.1, Mythos 5.1, Opus 5; others -> 400 'output_config.effort requires a model that supports per-turn effort; this model does not'.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5"
  ],
  "beta_header": "mid-conversation-output-config-2026-07-01",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/effort",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "failure",
   "http_status": 400,
   "request_note": "effort_per_message_sonnet5_beta -> 400 (documented rejection)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.task_budget",
  "location": "body",
  "type": "object (BetaTokenTaskBudget) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Advisory token budget for a whole agentic loop (thinking + tool calls + tool results + output); the model sees a server-injected countdown. Soft hint, not enforced. Doc minimum 20,000 (reference schema says minimum 1024 — discrepancy). Doc says unsupported on Sonnet 5, but a Sonnet 5 request with the header and total 20000 returned 200 (silently accepted?).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7"
  ],
  "beta_header": "task-budgets-2026-03-13",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_DISCOVERED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/task-budgets",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "task_budget_sonnet5_unsupported -> 200 with usage.iterations present"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.task_budget.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tokens"
  ],
  "description": "Always 'tokens'.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7"
  ],
  "beta_header": "task-budgets-2026-03-13",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/task-budgets",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.task_budget.total",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 20000,
  "maximum": null,
  "enum": null,
  "description": "Total tokens for the agentic loop. Documented minimum 20,000; schema minimum 1024.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7"
  ],
  "beta_header": "task-budgets-2026-03-13",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/task-budgets",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.task_budget.remaining",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "Budget remainder carried over after client-side compaction. Defaults to total. Not allowed with the compaction parameter or a signed compaction block (400). Changing it invalidates the cache.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7"
  ],
  "beta_header": "task-budgets-2026-03-13",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/task-budgets",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "speed",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "standard",
  "minimum": null,
  "maximum": null,
  "enum": [
   "standard",
   "fast"
  ],
  "description": "Inference speed. 'fast' = up to 2.5x output tokens/s at 2x pricing ($10/$50 Opus 5 & 4.8), research preview, dedicated rate limit. Requires beta header; without it -> 400 'speed: Extra inputs are not permitted'. Unsupported model -> 400 \"'<model>' does not support the `speed` parameter\". Opus 4.6: silently runs standard. Switching speed invalidates system+messages cache. Not on Batch API, Priority Tier, Bedrock/Vertex/Foundry/Claude Platform on AWS.",
  "compatible_models": [
   "claude-opus-5",
   "claude-opus-4-8"
  ],
  "beta_header": "fast-mode-2026-02-01",
  "status": [
   "DOCUMENTED",
   "PREVIEW",
   "BETA",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/fast-mode",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": 429,
   "request_note": "fast_01 Opus 5 -> 429 rate_limit_error 'rate limit of 0 fast mode input tokens per minute'; speed:'standard' -> 200 usage.speed='standard'"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "anthropic-beta: context-1m-2025-08-07",
  "location": "header",
  "type": "header",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Legacy 1M-context beta header. 1M is now the default (no header) on Opus 4.6+/Sonnet 4.6+/Sonnet 5/Opus 5/Fable; retired for Sonnet 4.5/Sonnet 4 (no effect, >200k errors). Observed: accepted and ignored on Sonnet 5 and Haiku 4.5.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "context-1m-2025-08-07",
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/context-windows",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "ctx1m_01/02 -> 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "anthropic-beta: model-context-window-exceeded-2025-08-26",
  "location": "header",
  "type": "header",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opt older models into stop_reason model_context_window_exceeded instead of a validation error when input + max_tokens exceeds the window (default behaviour on 4.5+).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "model-context-window-exceeded-2025-08-26",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/context-windows",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management",
  "location": "body",
  "type": "object (BetaContextManagementConfig) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Server-side context editing. Requires beta header (without: 400 'context_management: Extra inputs are not permitted'). Also accepted by count_tokens (returns context_management.original_input_tokens).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/context-editing",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "ctxedit_01 applied_edits clear_tool_uses cleared_tool_uses 2 cleared_input_tokens 174"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[]",
  "location": "body",
  "type": "array of edit objects",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ordered strategies. clear_thinking_20251015 must be listed first when combined. Types: clear_tool_uses_20250919, clear_thinking_20251015, compact_20260112.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "context-management-2025-06-27 (compact_20260112: compact-2026-01-12)",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/context-editing",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "clear_tool_uses_20250919",
   "clear_thinking_20251015",
   "compact_20260112"
  ],
  "description": "Edit strategy.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].trigger",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "clear_tool_uses/compact: {type: input_tokens, value} or {type: tool_uses, value}.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].keep",
  "location": "body",
  "type": "object | 'all'",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "clear_tool_uses: {type:'tool_uses', value} default 3. clear_thinking: {type:'thinking_turns', value>=1} | {type:'all'} | 'all'; default model-specific (all turns on Opus 4.5+/Sonnet 4.6+/Fable, last turn on Haiku & earlier).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/context-editing",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].clear_at_least",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{type:'input_tokens', value}: minimum tokens that must be clearable or the strategy is skipped (protects the prompt cache). clear_tool_uses only.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/context-editing",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].exclude_tools",
  "location": "body",
  "type": "array of string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tool names whose uses/results are never cleared (clear_tool_uses).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/context-editing",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].clear_tool_inputs",
  "location": "body",
  "type": "boolean | array of string | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Also clear tool_use inputs (all, or listed tool names). Default false (results only).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/context-editing",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].pause_after_compaction",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "compact_20260112: stop after compaction (stop_reason `compaction`).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "compact-2026-01-12",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "compact_20260112: custom summarization prompt; completely replaces the default. On Fable 5.1/Mythos 5.1 custom instructions summarize the visible conversation only (no earlier thinking).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6"
  ],
  "beta_header": "compact-2026-01-12",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/compaction",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "compaction",
  "location": "body",
  "type": "object (BetaCompactionConfig) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "On-demand compaction (beta compact-2026-09-04): {type:'summarize', instructions?}. Summarizes every message sent, returns a single signed compaction block, no reply, stop_reason 'compaction', top-level usage 0 with usage.iterations[type=compaction]. Cannot combine with context_management, stop_sequences, output_config.format, tool_choice any/tool, task_budget.remaining. Send the block first in later requests (else 400 compaction_block_misplaced).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6"
  ],
  "beta_header": "compact-2026-09-04",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/compaction",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "compact_04 Sonnet 5 -> compaction block + signature; compact_05 continuation -> 200; compact_06 misplaced -> 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "compaction.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "summarize"
  ],
  "description": "Always `summarize`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "compact-2026-09-04",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "compaction.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 16384,
  "enum": null,
  "description": "Replaces the server summarization prompt (max 16,384 chars; blank counts as absent). The summarizer reads earlier thinking too in this mode.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6"
  ],
  "beta_header": "compact-2026-09-04",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/compaction",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.format",
  "location": "body",
  "type": "object (JSONOutputFormat) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON outputs: constrain the text response to a JSON Schema via constrained decoding. GA, no beta header. Legacy top-level output_format -> 400 \"output_format: This field is deprecated. Use 'output_config.format' instead\". 400 with citations enabled ('Citations cannot be enabled when output format is set'). Incompatible with prefill and max_tokens:0. Adds a system prompt (more input tokens) and invalidates the cache when changed.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/structured-outputs",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "so_01 -> {\"name\":\"Ada\",\"age\":36,\"city\":\"Lyon\"}; so_07 legacy output_format -> 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_schema"
  ],
  "description": "Always `json_schema`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.format.schema",
  "location": "body",
  "type": "object (JSON Schema subset)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Supported: basic types, enum (primitives), const, anyOf/allOf (no allOf+$ref), $ref/$defs/definitions (internal), default, required, additionalProperties:false, formats date-time/time/date/duration/email/hostname/uri/ipv4/ipv6/uuid, minItems 0|1, simple regex pattern. Unsupported -> 400 e.g. \"For 'object' type, property 'patternProperties' is not supported\", \"For 'integer' type, property 'minimum' is not supported\". Limits: 20 strict tools, 24 optional params, 16 union params, 180 s compile timeout.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/structured-outputs",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "failure",
   "http_status": 400,
   "request_note": "so_03 patternProperties; so_04 minimum"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "output_config.format",
  "location": "body",
  "type": "object (JSONOutputFormat) | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "count_tokens accepts output_config.format (no grammar compilation); observed same input_tokens (205) as the real call.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/structured-outputs",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "so_05_count_tokens"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].strict",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Grammar-constrained validation of tool name+input. Not on mcp_toolset/computer_toolset/browser_toolset; not with code_execution callers (400).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/strict-tool-use",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].citations.enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Document-level citations config: enable citations for this document.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[] {type:'document'}",
  "location": "body",
  "type": "object (DocumentBlockParam)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Document block. source variants: base64 (application/pdf), text (text/plain), content (custom content: array of text/image blocks), url, file (file_id). Optional title, context, citations, cache_control.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/pdf-support",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.type (document)",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64",
   "text",
   "content",
   "url",
   "file"
  ],
  "description": "Document source discriminator.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/citations",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "base64 PDF, text, content, file verified; url documented"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.media_type (document)",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/pdf",
   "text/plain"
  ],
  "description": "application/pdf for base64; text/plain for text sources. Files API: PDF or text/plain files only in document blocks.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/pdf-support",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].title (document)",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Passed to the model, echoed as document_title in citations, not citable. Limited length (use context for metadata).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/citations",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].context (document)",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free-text metadata shown to the model, not citable.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/citations",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[] {type:'search_result'}",
  "location": "body",
  "type": "object (SearchResultBlockParam)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "RAG result block: source (string), title (string), content (array of non-empty text blocks), citations, cache_control. User messages and tool_result only (all-or-nothing inside a tool_result). Cited as search_result_location with block indices.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/search-results",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "cite_02 search_result_index 0 start_block_index 1 end_block_index 2"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[] {type:'image'}",
  "location": "body",
  "type": "object (ImageBlockParam)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image block. source: base64 (media_type image/jpeg|png|gif|webp), url, file (file_id). Limits: 8000x8000 px, 10 MB base64 (5 MB Bedrock/Vertex), 100 images/request on 200k models, 600 on 1M models; >20 images => per-image ~2000 px limit. Cost = ceil(w/28)*ceil(h/28) visual tokens, capped by tier (1568 std, 4784 on 4.7+). Invalid bytes -> 400 'Could not process image'; unreachable URL -> 400 'Unable to download the file'.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/vision",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "vision_01 1x1 PNG -> 'Red', input_tokens 21; vision_07 httpbin URL -> 200; wikimedia URL -> 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.type (image)",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64",
   "url",
   "file"
  ],
  "description": "Image source discriminator.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/vision",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.media_type (image)",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image/jpeg",
   "image/png",
   "image/gif",
   "image/webp"
  ],
  "description": "Image MIME type (base64 sources). Animations: first frame only.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/vision",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].transformations.oversized_image",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "downsize",
  "minimum": null,
  "maximum": null,
  "enum": [
   "downsize",
   "error"
  ],
  "description": "What to do when the image exceeds the model's max size: `downsize` (default, silent) or `error` (400).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[] {type:'container_upload'}",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reference a Files API file inside the code execution container: {type:'container_upload', file_id}.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/files",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/files",
  "parameter": "file",
  "location": "body",
  "type": "binary (multipart part)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File to upload. filename final path component kept; Content-Type on the part optional (detected: an application/octet-stream .txt part was stored as text/plain). Max 500 MB; 1 TB per org (guide) — reference says 100 GB in older text.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "files_01 size_bytes 101 text/plain downloadable false expires_at null"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/files",
  "parameter": "expires_in_seconds",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 3600,
  "maximum": 7776000,
  "enum": null,
  "description": "Seconds until the file expires (3600..7776000). 400 'expires_in_seconds: must be between 3600 and 7776000' otherwise. expires_at = upload time + value.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "files_09 3600 -> expires_at +1h; files_14 60 -> 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/files",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Page size, default 20, 1..1000.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/files",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor (prefixed page_) from next_page.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/files",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/files",
  "parameter": "ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 100,
  "enum": null,
  "description": "Up to 100 ids; single page; unknown ids silently omitted; exclusive with page/limit.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "files_04"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/files",
  "parameter": "before_id / after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Legacy cursors, only with anthropic-beta: files-api-2025-04-14 (response then has has_more/first_id/last_id instead of next_page). 400 without the header.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": "files-api-2025-04-14",
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "files_03 legacy header -> {data, has_more, first_id, last_id}, no expires_at"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/files",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional header selecting the workspace (files are workspace-scoped).",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/files",
  "verification": null,
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Path parameter for GET/DELETE /v1/files/{file_id} and GET /v1/files/{file_id}/content.",
  "compatible_models": [
   "claude-fable-5-1",
   "claude-opus-5",
   "claude-sonnet-5",
   "claude-fable-5",
   "claude-opus-4-8",
   "claude-opus-4-7",
   "claude-sonnet-4-6",
   "claude-opus-4-6",
   "claude-opus-4-5-20251101",
   "claude-haiku-4-5-20251001",
   "claude-sonnet-4-5-20250929"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": ""
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/anthropic-advanced.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Files API id (`file` source). Not accepted by /v1/messages/count_tokens.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/messages/batches",
  "parameter": "after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/list",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/messages/batches",
  "parameter": "before_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/list",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/messages/batches",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/list",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/messages/batches",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/list",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests",
  "location": "body",
  "type": "array of object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of requests for prompt completion. Each is an individual request to create a Message.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxItems": "100000",
   "minItems": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].custom_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,64}$",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Messages API creation parameters for the individual request. See the [Messages API reference](https://platform.claude.com/docs/en/api/messages) for full documentation on available parameters.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.max_tokens",
  "location": "body",
  "type": "number",
  "required": true,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter.  See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.messages",
  "location": "body",
  "type": "array of BetaMessageParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{\"role\": \"user\", \"content\": \"Hello, Claude\"}] ``` Example with multiple conversational turns: ```json [ {\"role\": \"user\", \"content\": \"Hello there.\"}, {\"role\": \"assistant\", \"content\": \"Hi, I'm Claude. How can I help you?\"}, {\"role\": \"user\", \"content\": \"Can you explain LLMs in plain English?\"}, ] ``` Example with a partially-filled response from Claude: ```json [ {\"role\": \"user\", \"content\": \"What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun\"}, {\"role\": \"assistant\", \"content\": \"The best answer is (\"}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `\"text\"`. The following input messages are equivalent: ```json {\"role\": \"user\", \"content\": \"Hello, Claude\"} ``` ```json {\"role\": \"user\", \"content\": [{\"type\": \"text\", \"text\": \"Hello, Claude\"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `\"system\"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.messages[].content",
  "location": "body",
  "type": "string or array of BetaContentBlockParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.messages[].role",
  "location": "body",
  "type": "\"user\" or \"assistant\" or \"system\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant",
   "system"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.messages[].clear_at",
  "location": "body",
  "type": "\"next_user_message\" or \"never\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "next_user_message",
   "never"
  ],
  "description": "How long this system message's text stays in front of the model. `\"never\"` (the default) renders it on every request that includes it. `\"next_user_message\"` renders it only for the user turn it follows: once a later `role: \"user\"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: \"system\"` messages.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.messages[].output_config",
  "location": "body",
  "type": "BetaSystemMessageOutputConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-message output configuration on a role:\"system\" input message. Fields here apply per-turn; `format` remains top-level only. An empty `{}` is accepted on a message that carries content; a message with neither content nor output_config fields is rejected.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.messages[].output_config.effort",
  "location": "body",
  "type": "\"low\" or \"medium\" or \"high\" or 2 more or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "All possible effort levels.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.model",
  "location": "body",
  "type": "Model",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.cache_control",
  "location": "body",
  "type": "BetaCacheControlEphemeral or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.compaction",
  "location": "body",
  "type": "BetaCompactionConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Compact the whole conversation and return a signed `compaction` block, alone, that a later request sends back first in `messages`, in place of the messages it summarizes. There is no trigger and no pause flag: sending the parameter compacts, and nothing is sampled after the block. The summarization prompt is the server's own unless `instructions` are given, which then replace it for this request; a value that is empty or only whitespace counts as absent.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.compaction.type",
  "location": "body",
  "type": "\"summarize\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.compaction.instructions",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "16384"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.container",
  "location": "body",
  "type": "BetaContainerParams or string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Container identifier for reuse across requests.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.container.id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Container id",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.container.skills",
  "location": "body",
  "type": "array of BetaSkillParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of skills to load in the container",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxItems": "20"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.container.skills[].type",
  "location": "body",
  "type": "\"anthropic\" or \"custom\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "anthropic",
   "custom"
  ],
  "description": "Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.container.skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skill ID",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "64",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.container.skills[].version",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skill version or 'latest' for most recent version",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "64",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.context_management",
  "location": "body",
  "type": "BetaContextManagementConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.context_management.edits",
  "location": "body",
  "type": "array of BetaClearToolUses20250919Edit or BetaClearThinking20251015Edit or BetaCompact20260112Edit",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of context management edits to apply",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "minItems": "0"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.diagnostics",
  "location": "body",
  "type": "BetaDiagnosticsParam or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.diagnostics.previous_message_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallback_credit_token",
  "location": "body",
  "type": "string or BetaFallbackCreditTokenParam or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The `fallback_credit_token` from a prior refusal's `stop_details`. When a preceding request was refused and returned a `fallback_credit_token`, pass that code here on the retry to have the retry's cache-creation tokens for the prefix that was warm on the refused model billed at the cache-read rate. Must be redeemed by the same organization and workspace, with the same request body (optionally extended by one appended `assistant` message whose content is the partial text — with any trailing whitespace stripped from the final text block — and paired server-tool blocks streamed before the refusal; the appended-assistant form is not available for requests with `output_format` set or forced `tool_choice`), on an eligible fallback model, on the same platform, and within 5 minutes of the refusal; a mismatch is a 400. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed with the appended-assistant form — if an exact-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry with the appended-assistant form instead. When the appended-assistant form is used on a model that otherwise disallows assistant-turn prefill, this token also authorizes that one prefill.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallback_credit_token.token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "2048",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallback_credit_token.mode",
  "location": "body",
  "type": "\"strict\" or \"best_effort\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "strict",
   "best_effort"
  ],
  "description": "How a failing token affects the retry. `strict` (the default, and the bare-string behavior): a failing redemption is a 400 and the retry is not served. `best_effort`: the retry is served either way — a token-layer failure no longer rejects the request; the retry proceeds at normal price and the outcome is reported on the response's `usage.fallback_credit`. Two failures stay hard in both modes: a malformed token, and combining `fallback_credit_token` with `fallbacks`.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallbacks",
  "location": "body",
  "type": "BetaFallbacksParam or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. The string \"default\" requests the requested model's server-defined default fallback configuration.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallbacks.model",
  "location": "body",
  "type": "Model",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallbacks.max_tokens",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallbacks.output_config",
  "location": "body",
  "type": "BetaOutputConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallbacks.output_config.effort",
  "location": "body",
  "type": "\"low\" or \"medium\" or \"high\" or 2 more or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "All possible effort levels.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallbacks.output_config.format",
  "location": "body",
  "type": "BetaJSONOutputFormat or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallbacks.output_config.task_budget",
  "location": "body",
  "type": "BetaTokenTaskBudget or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-configurable total token budget across contexts.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallbacks.speed",
  "location": "body",
  "type": "\"standard\" or \"fast\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "standard",
   "fast"
  ],
  "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.fallbacks.thinking",
  "location": "body",
  "type": "BetaThinkingConfigEnabled or BetaThinkingConfigDisabled or BetaThinkingConfigAdaptive or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.inference_geo",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.mcp_servers",
  "location": "body",
  "type": "array of BetaRequestMCPServerURLDefinition",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MCP servers to be utilized in this request",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxItems": "20"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.mcp_servers[].type",
  "location": "body",
  "type": "\"url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.mcp_servers[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.mcp_servers[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.mcp_servers[].authorization_token",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.mcp_servers[].tool_configuration",
  "location": "body",
  "type": "BetaRequestMCPServerToolConfiguration or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.mcp_servers[].tool_configuration.allowed_tools",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.mcp_servers[].tool_configuration.enabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.metadata",
  "location": "body",
  "type": "BetaMetadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object describing metadata about the request.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.metadata.user_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "512"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.output_config",
  "location": "body",
  "type": "BetaOutputConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration options for the model's output, such as the output format.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.service_tier",
  "location": "body",
  "type": "\"auto\" or \"standard_only\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "standard_only"
  ],
  "description": "Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.speed",
  "location": "body",
  "type": "\"standard\" or \"fast\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "standard",
   "fast"
  ],
  "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.stop_sequences",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `\"end_turn\"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `\"stop_sequence\"` and the response `stop_sequence` value will contain the matched stop sequence.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.stream",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to incrementally stream the response using server-sent events. See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.system",
  "location": "body",
  "type": "string or array of BetaTextBlockParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role).",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.system.type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.system.text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.system.cache_control",
  "location": "body",
  "type": "BetaCacheControlEphemeral or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Create a cache control breakpoint at this content block.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.system.citations",
  "location": "body",
  "type": "array of BetaTextCitationParam or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.thinking",
  "location": "body",
  "type": "BetaThinkingConfigParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tool_choice",
  "location": "body",
  "type": "BetaToolChoice",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tool_choice.type",
  "location": "body",
  "type": "\"auto\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tool_choice.disable_parallel_tool_use",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tool_choice.type",
  "location": "body",
  "type": "\"any\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tool_choice.type",
  "location": "body",
  "type": "\"tool\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool to use.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tool_choice.type",
  "location": "body",
  "type": "\"none\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools",
  "location": "body",
  "type": "array of BetaToolUnion",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { \"name\": \"get_stock_price\", \"description\": \"Get the current stock price for a given ticker symbol.\", \"input_schema\": { \"type\": \"object\", \"properties\": { \"ticker\": { \"type\": \"string\", \"description\": \"The stock ticker symbol, e.g. AAPL for Apple Inc.\" } }, \"required\": [\"ticker\"] } } ] ``` And then asked the model \"What's the S&P 500 at today?\", the model might produce `tool_use` content blocks in the response like this: ```json [ { \"type\": \"tool_use\", \"id\": \"toolu_01D7FLrfh4GYq7yT1ULFeyMV\", \"name\": \"get_stock_price\", \"input\": { \"ticker\": \"^GSPC\" } } ] ``` You might then run your `get_stock_price` tool with `{\"ticker\": \"^GSPC\"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { \"type\": \"tool_result\", \"tool_use_id\": \"toolu_01D7FLrfh4GYq7yT1ULFeyMV\", \"content\": \"259.75 USD\" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"custom\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].input_schema",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].input_schema.type",
  "location": "body",
  "type": "\"object\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].input_schema.properties",
  "location": "body",
  "type": "map[unknown] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].input_schema.required",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].allowed_callers",
  "location": "body",
  "type": "array of \"direct\" or \"code_execution_20250825\" or \"code_execution_20260120\" or \"code_execution_20260521\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "direct",
   "code_execution_20250825",
   "code_execution_20260120",
   "code_execution_20260521"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].cache_control",
  "location": "body",
  "type": "BetaCacheControlEphemeral or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Create a cache control breakpoint at this content block.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].eager_input_streaming",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].input_examples",
  "location": "body",
  "type": "array of map[unknown]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].strict",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, guarantees schema validation on tool names and inputs",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"bash_20241022\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"bash\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"bash_20250124\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"code_execution_20250522\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"code_execution\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"code_execution_20250825\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"code_execution_20260120\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"code_execution_20260521\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"browser_toolset_20260801\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs",
  "location": "body",
  "type": "BetaBrowserToolsetConfigs or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-member configuration for `browser_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.type",
  "location": "body",
  "type": "BetaBrowserTypeConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`type`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.close_tab",
  "location": "body",
  "type": "BetaBrowserCloseTabConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`close_tab`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.double_click",
  "location": "body",
  "type": "BetaBrowserDoubleClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`double_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.file_upload",
  "location": "body",
  "type": "BetaBrowserFileUploadConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`file_upload`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.find",
  "location": "body",
  "type": "BetaBrowserFindConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`find`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.form_input",
  "location": "body",
  "type": "BetaBrowserFormInputConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`form_input`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.get_page_text",
  "location": "body",
  "type": "BetaBrowserGetPageTextConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`get_page_text`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.hold_key",
  "location": "body",
  "type": "BetaBrowserHoldKeyConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`hold_key`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.hover",
  "location": "body",
  "type": "BetaBrowserHoverConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`hover`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.javascript_exec",
  "location": "body",
  "type": "BetaBrowserJavascriptExecConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`javascript_exec`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.key",
  "location": "body",
  "type": "BetaBrowserKeyConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`key`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.left_click",
  "location": "body",
  "type": "BetaBrowserLeftClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`left_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.left_click_drag",
  "location": "body",
  "type": "BetaBrowserLeftClickDragConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`left_click_drag`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.left_mouse_down",
  "location": "body",
  "type": "BetaBrowserLeftMouseDownConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`left_mouse_down`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.left_mouse_up",
  "location": "body",
  "type": "BetaBrowserLeftMouseUpConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`left_mouse_up`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.list_tabs",
  "location": "body",
  "type": "BetaBrowserListTabsConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`list_tabs`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.middle_click",
  "location": "body",
  "type": "BetaBrowserMiddleClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`middle_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.mouse_move",
  "location": "body",
  "type": "BetaBrowserMouseMoveConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`mouse_move`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.navigate",
  "location": "body",
  "type": "BetaBrowserNavigateConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`navigate`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.new_tab",
  "location": "body",
  "type": "BetaBrowserNewTabConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`new_tab`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.read_console",
  "location": "body",
  "type": "BetaBrowserReadConsoleConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`read_console`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.read_network",
  "location": "body",
  "type": "BetaBrowserReadNetworkConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`read_network`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.read_page",
  "location": "body",
  "type": "BetaBrowserReadPageConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`read_page`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.right_click",
  "location": "body",
  "type": "BetaBrowserRightClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`right_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.screenshot",
  "location": "body",
  "type": "BetaBrowserScreenshotConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`screenshot`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.scroll",
  "location": "body",
  "type": "BetaBrowserScrollConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`scroll`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.scroll_to",
  "location": "body",
  "type": "BetaBrowserScrollToConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`scroll_to`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.switch_tab",
  "location": "body",
  "type": "BetaBrowserSwitchTabConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`switch_tab`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.triple_click",
  "location": "body",
  "type": "BetaBrowserTripleClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`triple_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.wait",
  "location": "body",
  "type": "BetaBrowserWaitConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`wait`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.zoom",
  "location": "body",
  "type": "BetaBrowserZoomConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`zoom`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"computer_20241022\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].display_height_px",
  "location": "body",
  "type": "number",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "The height of the display in pixels.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].display_width_px",
  "location": "body",
  "type": "number",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "The width of the display in pixels.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"computer\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].display_number",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "The X11 display number (e.g. 0, 1) for the display.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"memory_20250818\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"memory\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"computer_20250124\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"text_editor_20241022\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"str_replace_editor\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"computer_20251124\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].enable_zoom",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable an action to take a zoomed-in screenshot of the screen.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"computer_toolset_20260801\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs",
  "location": "body",
  "type": "BetaComputerToolsetConfigs or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-member configuration for `computer_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.type",
  "location": "body",
  "type": "BetaComputerTypeConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`type`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.cursor_position",
  "location": "body",
  "type": "BetaComputerCursorPositionConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`cursor_position`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.double_click",
  "location": "body",
  "type": "BetaComputerDoubleClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`double_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.hold_key",
  "location": "body",
  "type": "BetaComputerHoldKeyConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`hold_key`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.key",
  "location": "body",
  "type": "BetaComputerKeyConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`key`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.left_click",
  "location": "body",
  "type": "BetaComputerLeftClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`left_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.left_click_drag",
  "location": "body",
  "type": "BetaComputerLeftClickDragConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`left_click_drag`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.left_mouse_down",
  "location": "body",
  "type": "BetaComputerLeftMouseDownConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`left_mouse_down`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.left_mouse_up",
  "location": "body",
  "type": "BetaComputerLeftMouseUpConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`left_mouse_up`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.middle_click",
  "location": "body",
  "type": "BetaComputerMiddleClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`middle_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.mouse_move",
  "location": "body",
  "type": "BetaComputerMouseMoveConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`mouse_move`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.right_click",
  "location": "body",
  "type": "BetaComputerRightClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`right_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.screenshot",
  "location": "body",
  "type": "BetaComputerScreenshotConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`screenshot`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.scroll",
  "location": "body",
  "type": "BetaComputerScrollConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`scroll`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.triple_click",
  "location": "body",
  "type": "BetaComputerTripleClickConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`triple_click`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.wait",
  "location": "body",
  "type": "BetaComputerWaitConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`wait`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.zoom",
  "location": "body",
  "type": "BetaComputerZoomConfig or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`zoom`'s config overrides.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"text_editor_20250124\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"text_editor_20250429\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"str_replace_based_edit_tool\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"text_editor_20250728\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].max_characters",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"web_search_20250305\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"web_search\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].allowed_domains",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of domains to allow fetching from",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].blocked_domains",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of domains to block fetching from",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].max_uses",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of times the tool can be used in the API request. exclusiveMinimum: 0",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].user_location",
  "location": "body",
  "type": "BetaUserLocation or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Parameters for the user's location. Used to provide more relevant search results.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].user_location.type",
  "location": "body",
  "type": "\"approximate\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].user_location.city",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The city of the user.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].user_location.country",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "2",
   "minLength": "2"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].user_location.region",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The region of the user.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].user_location.timezone",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The [IANA timezone](https://nodatime.org/TimeZones) of the user.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"web_fetch_20250910\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"web_fetch\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].citations",
  "location": "body",
  "type": "BetaCitationsConfigParam or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Citations configuration for fetched documents. Citations are disabled by default.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].max_content_tokens",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. exclusiveMinimum: 0",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].url_sources",
  "location": "body",
  "type": "BetaWebFetchURLSources or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Which sources contribute to the set of URLs web fetch may fetch. Each key is a tagged variant: `user_input` is `all` or `none`; the two tool filters are `all`, `none`, `only` (only the named tools' results) or `except` (every result but the named tools'). A named tool must be declared in this request's `tools[]`.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].url_sources.client_tool_results",
  "location": "body",
  "type": "BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Which client tools' results contribute fetchable URLs: \"all\", \"none\", or an only or except list of client tool names from tools[].",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].url_sources.server_tool_results",
  "location": "body",
  "type": "BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Which server tools' results contribute fetchable URLs: \"all\", \"none\", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].url_sources.user_input",
  "location": "body",
  "type": "BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether URLs in user messages are fetchable: \"all\" or \"none\".",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"web_search_20260209\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"web_fetch_20260209\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"web_fetch_20260309\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].use_cache",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"web_search_20260318\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].response_inclusion",
  "location": "body",
  "type": "\"full\" or \"excluded\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "full",
   "excluded"
  ],
  "description": "How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"web_fetch_20260318\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"advisor_20260301\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].model",
  "location": "body",
  "type": "Model",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"advisor\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].caching",
  "location": "body",
  "type": "BetaCacheControlEphemeral or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].max_tokens",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": 1024,
  "maximum": null,
  "enum": null,
  "description": "Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"tool_search_tool_bm25_20251119\" or \"tool_search_tool_bm25\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_tool_bm25_20251119",
   "tool_search_tool_bm25"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"tool_search_tool_bm25\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"tool_search_tool_regex_20251119\" or \"tool_search_tool_regex\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_tool_regex_20251119",
   "tool_search_tool_regex"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].name",
  "location": "body",
  "type": "\"tool_search_tool_regex\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].type",
  "location": "body",
  "type": "\"mcp_toolset\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].mcp_server_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the MCP server to configure tools for",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "constraints": {
   "maxLength": "255",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs",
  "location": "body",
  "type": "map[BetaMCPToolConfig] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration overrides for specific tools, keyed by tool name",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].configs.enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].default_config",
  "location": "body",
  "type": "BetaMCPToolDefaultConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default configuration applied to all tools from this server",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].default_config.defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.tools[].default_config.enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.output_format",
  "location": "body",
  "type": "BetaJSONOutputFormat or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "**Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) A schema to specify Claude's output format in responses. This parameter will be removed in a future release.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "description": "**Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.top_k",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "**Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. Only sample from the top K options for each subsequent token. Used to remove \"long tail\" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "requests[].params.top_p",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "description": "**Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "anthropic-user-profile-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/create",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/messages/batches/{message_batch_id}",
  "parameter": "message_batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Message Batch.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/delete",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/messages/batches/{message_batch_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/delete",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/messages/batches/{message_batch_id}",
  "parameter": "message_batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Message Batch.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/messages/batches/{message_batch_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches/{message_batch_id}/cancel",
  "parameter": "message_batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Message Batch.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/cancel",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/batches/{message_batch_id}/cancel",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/cancel",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/messages/batches/{message_batch_id}/results",
  "parameter": "message_batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the Message Batch.",
  "compatible_models": null,
  "beta_header": "message-batches-2024-09-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/results",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/messages/batches/{message_batch_id}/results",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/batches/results",
  "_fragment": "generated/fragments/parameters/anthropic-batches.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Model id. Live (2026-09-18): every request, with claude-2.1 or claude-haiku-4-5-20251001, returns 400 'The /v1/complete endpoint has been deprecated. Please use the /v1/messages endpoint instead.'",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": [],
  "description": "Prompt with alternating '\\n\\nHuman:' / '\\n\\nAssistant:' turns (minLength 1).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "max_tokens_to_sample",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": [],
  "description": "Max tokens to generate (≥1).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "stop_sequences",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Extra stop strings; the model always stops on '\\n\\nHuman:'.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "stream",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "SSE streaming of `completion` events.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1.0,
  "minimum": 0,
  "maximum": 1,
  "enum": [],
  "description": "0..1, default 1.0 (deprecated semantics as in Messages).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "top_p",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": [],
  "description": "Nucleus sampling.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "top_k",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": [],
  "description": "Top-K sampling.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "metadata.user_id",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 512,
  "enum": [],
  "description": "Opaque end-user id (≤512).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "anthropic-beta",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Optional beta header(s).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/complete",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Workspace id.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://platform.claude.com/docs/en/api/completions",
  "_fragment": "generated/fragments/parameters/anthropic-complete-legacy.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "activity_types[]",
  "location": "query",
  "type": "array of \"abuse_decision_received\" or \"account_deleted\" or \"admin_api_key_created\" or 503 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "abuse_decision_received",
   "account_deleted",
   "admin_api_key_created",
   "admin_api_key_deleted",
   "admin_api_key_updated",
   "admin_connector_request_resolved",
   "admin_request_created",
   "admin_setup_checklist_step_delegated",
   "admin_setup_checklist_step_delegation_cancelled",
   "age_verified",
   "anonymous_mobile_login_attempted",
   "api_key_created",
   "audit_log_export_accessed",
   "audit_log_export_started",
   "billing_emails_updated",
   "ccr_agent_created",
   "ccr_agent_deleted",
   "ccr_agent_proxy_anthropic_oidc_token_exchanged",
   "ccr_agent_proxy_anthropic_oidc_token_minted",
   "ccr_agent_proxy_credential_created",
   "ccr_agent_proxy_credential_deleted",
   "ccr_agent_proxy_credential_rotated",
   "ccr_agent_proxy_credential_updated",
   "ccr_agent_proxy_destination_deleted",
   "ccr_agent_proxy_network_events_listed",
   "ccr_agent_proxy_profile_bound",
   "ccr_agent_proxy_profile_created",
   "ccr_agent_proxy_profile_deleted",
   "ccr_agent_proxy_profile_unbound",
   "ccr_agent_proxy_profile_updated",
   "ccr_agent_proxy_provisioning_credential_rejected",
   "ccr_agent_proxy_provisioning_link_enabled",
   "ccr_agent_proxy_provisioning_link_generated",
   "ccr_agent_proxy_provisioning_link_revoked",
   "ccr_agent_proxy_provisioning_link_submitted",
   "ccr_agent_proxy_rule_created",
   "ccr_agent_proxy_rule_deleted",
   "ccr_agent_proxy_rule_updated",
   "ccr_agent_slack_access_scope_created",
   "ccr_agent_slack_access_scope_deleted",
   "ccr_agent_slack_binding_created",
   "ccr_agent_slack_binding_deleted",
   "ccr_agent_updated",
   "ccr_channel_manager_added",
   "ccr_channel_manager_removed",
   "ccr_role_channel_assignment_deleted",
   "ccr_role_channel_assignment_updated",
   "ccr_session_created",
   "ccr_session_deleted",
   "ccr_session_updated",
   "ccr_slack_channel_joined",
   "claude_artifact_access_failed",
   "claude_artifact_commented",
   "claude_artifact_comments_viewed",
   "claude_artifact_created",
   "claude_artifact_duplicated",
   "claude_artifact_external_sharing_permission_updated",
   "claude_artifact_published",
   "claude_artifact_sharing_updated",
   "claude_artifact_viewed",
   "claude_chat_access_failed",
   "claude_chat_created",
   "claude_chat_deleted",
   "claude_chat_deletion_failed",
   "claude_chat_settings_updated",
   "claude_chat_snapshot_created",
   "claude_chat_snapshot_deleted",
   "claude_chat_snapshot_viewed",
   "claude_chat_sync_source_created",
   "claude_chat_sync_source_deleted",
   "claude_chat_sync_source_updated",
   "claude_chat_updated",
   "claude_chat_viewed",
   "claude_code_credential_revoked",
   "claude_code_review_config_updated",
   "claude_code_review_repository_added",
   "claude_code_review_repository_removed",
   "claude_code_review_repository_updated",
   "claude_code_runner_deleted",
   "claude_code_runner_pool_created",
   "claude_code_runner_pool_deleted",
   "claude_code_runner_pool_secret_minted",
   "claude_code_runner_pool_session_queue_updated",
   "claude_code_runner_pool_updated",
   "claude_code_security_center_config_updated",
   "claude_code_security_scan_cancelled",
   "claude_code_security_scan_created",
   "claude_code_security_scan_project_member_updated",
   "claude_code_security_scan_project_updated",
   "claude_code_security_scan_project_visibility_updated",
   "claude_code_security_scan_run_updated",
   "claude_code_security_scan_schedule_deleted",
   "claude_code_security_scan_schedule_updated",
   "claude_code_security_vulnerability_deleted",
   "claude_code_security_vulnerability_fix_session_created",
   "claude_code_security_vulnerability_updated",
   "claude_code_security_webhook_created",
   "claude_code_security_webhook_deleted",
   "claude_code_security_webhook_secret_updated",
   "claude_code_security_webhook_updated",
   "claude_code_team_memory_acl_updated",
   "claude_code_team_memory_updated",
   "claude_code_team_onboarding_guide_updated",
   "claude_code_user_marketplaces_updated",
   "claude_code_user_memory_updated",
   "claude_code_user_plugins_updated",
   "claude_code_user_settings_updated",
   "claude_command_created",
   "claude_command_deleted",
   "claude_command_replaced",
   "claude_enterprise_upgrade_credit_updated",
   "claude_file_access_failed",
   "claude_file_deleted",
   "claude_file_exported",
   "claude_file_uploaded",
   "claude_file_viewed",
   "claude_gdrive_integration_created",
   "claude_gdrive_integration_deleted",
   "claude_gdrive_integration_updated",
   "claude_github_integration_created",
   "claude_github_integration_deleted",
   "claude_github_integration_updated",
   "claude_organization_settings_updated",
   "claude_plugin_created",
   "claude_plugin_deleted",
   "claude_plugin_disabled",
   "claude_plugin_enabled",
   "claude_plugin_replaced",
   "claude_plugin_security_scan_completed",
   "claude_plugin_updated",
   "claude_project_archived",
   "claude_project_created",
   "claude_project_deleted",
   "claude_project_document_access_failed",
   "claude_project_document_bulk_deletion_audit_truncated",
   "claude_project_document_deleted",
   "claude_project_document_deletion_failed",
   "claude_project_document_updated",
   "claude_project_document_uploaded",
   "claude_project_document_viewed",
   "claude_project_file_access_failed",
   "claude_project_file_bulk_deletion_audit_truncated",
   "claude_project_file_deleted",
   "claude_project_file_deletion_failed",
   "claude_project_file_uploaded",
   "claude_project_reported",
   "claude_project_sharing_updated",
   "claude_project_sync_source_created",
   "claude_project_sync_source_deleted",
   "claude_project_sync_source_updated",
   "claude_project_viewed",
   "claude_published_artifact_deleted",
   "claude_pubsec_identity_configured",
   "claude_skill_created",
   "claude_skill_deleted",
   "claude_skill_disabled",
   "claude_skill_enabled",
   "claude_skill_replaced",
   "claude_skill_security_scan_completed",
   "claude_user_role_updated",
   "claude_user_seat_tier_updated",
   "claude_user_settings_updated",
   "cli_plugin_exec_policy_updated",
   "compliance_api_accessed",
   "cowork_session_updated",
   "design_project_artifact_published",
   "design_project_created",
   "design_project_deleted",
   "design_project_member_added",
   "design_project_member_removed",
   "design_project_member_role_updated",
   "design_project_published",
   "design_project_sharing_updated",
   "design_project_unpublished",
   "design_project_updated",
   "design_project_version_restored",
   "design_project_viewed",
   "desktop_extension_allowlisted",
   "desktop_extension_blocklisted",
   "desktop_extension_deleted",
   "desktop_extension_removed_from_allowlist",
   "desktop_extension_unblocked",
   "desktop_extension_uploaded",
   "desktop_extension_version_uploaded",
   "domain_claim_initiated",
   "end_user_invite_requested",
   "extra_usage_billing_enabled",
   "extra_usage_credit_granted",
   "extra_usage_spend_limit_created",
   "extra_usage_spend_limit_deleted",
   "extra_usage_spend_limit_increase_request_approved",
   "extra_usage_spend_limit_increase_request_denied",
   "extra_usage_spend_limit_updated",
   "ghe_configuration_created",
   "ghe_configuration_deleted",
   "ghe_configuration_updated",
   "ghe_user_connected",
   "ghe_user_disconnected",
   "ghe_webhook_signature_invalid",
   "github_app_installation_linked",
   "github_app_installation_unlinked",
   "github_token_import",
   "group_created",
   "group_deleted",
   "group_list_viewed",
   "group_member_added",
   "group_member_addition_failed",
   "group_member_list_viewed",
   "group_member_removal_failed",
   "group_member_removed",
   "group_project_shares_revoked",
   "group_skill_shares_revoked",
   "group_updated",
   "group_viewed",
   "group_visibility_updated",
   "inference_hooks_circuit_breaker_tripped",
   "inference_hooks_config_deleted",
   "inference_hooks_config_updated",
   "inference_hooks_request_denied",
   "inference_hooks_request_failed_open",
   "inference_hooks_signing_secret_generated",
   "integration_user_connected",
   "integration_user_disconnected",
   "invoice_collection_method_updated",
   "lti_launch_initiated",
   "lti_launch_success",
   "lti_platform_created",
   "lti_platform_updated",
   "magic_link_login_failed",
   "magic_link_login_initiated",
   "magic_link_login_succeeded",
   "managed_organization_setup_completed",
   "marketplace_created",
   "marketplace_deleted",
   "marketplace_updated",
   "marketplace_webhook_deleted",
   "marketplace_webhook_provisioned",
   "mcp_directory_server_published",
   "mcp_server_created",
   "mcp_server_deleted",
   "mcp_server_managed_auth_token_exchanged",
   "mcp_server_managed_auth_updated",
   "mcp_server_updated",
   "mcp_tool_policy_updated",
   "org_analytics_api_capability_updated",
   "org_bulk_delete_initiated",
   "org_capability_grant_added",
   "org_capability_grant_removed",
   "org_claude_code_data_sharing_disabled",
   "org_claude_code_data_sharing_enabled",
   "org_claude_code_desktop_disabled",
   "org_claude_code_desktop_enabled",
   "org_claude_code_zero_data_retention_disabled",
   "org_compliance_api_settings_updated",
   "org_connector_domain_guard_updated",
   "org_cowork_act_without_asking_mode_disabled",
   "org_cowork_act_without_asking_mode_enabled",
   "org_cowork_agent_disabled",
   "org_cowork_agent_enabled",
   "org_cowork_auto_mode_disabled",
   "org_cowork_auto_mode_enabled",
   "org_cowork_browser_pane_disabled",
   "org_cowork_browser_pane_enabled",
   "org_cowork_disabled",
   "org_cowork_enabled",
   "org_cowork_mcp_always_allow_disabled",
   "org_cowork_mcp_always_allow_enabled",
   "org_cowork_otlp_settings_updated",
   "org_cowork_remote_disabled",
   "org_cowork_remote_enabled",
   "org_creation_blocked",
   "org_data_export_accessed",
   "org_data_export_completed",
   "org_data_export_started",
   "org_data_residency_updated",
   "org_deleted_via_bulk",
   "org_deletion_requested",
   "org_directory_resync_completed",
   "org_directory_resync_failed",
   "org_directory_resync_started",
   "org_directory_sync_activated",
   "org_directory_sync_add_initiated",
   "org_directory_sync_deleted",
   "org_discoverability_disabled",
   "org_discoverability_enabled",
   "org_discoverability_settings_updated",
   "org_domain_add_initiated",
   "org_domain_removed",
   "org_domain_verified",
   "org_external_key_created",
   "org_external_key_deleted",
   "org_external_key_updated",
   "org_external_key_validated",
   "org_hipaa_self_serve_enabled",
   "org_invite_link_disabled",
   "org_invite_link_generated",
   "org_invite_link_regenerated",
   "org_invite_viewed",
   "org_invites_listed",
   "org_ip_restriction_created",
   "org_ip_restriction_deleted",
   "org_ip_restriction_updated",
   "org_join_proposal_decided",
   "org_join_request_approved",
   "org_join_request_created",
   "org_join_request_dismissed",
   "org_join_request_instant_approved",
   "org_join_requests_bulk_dismissed",
   "org_magic_link_second_factor_toggled",
   "org_member_invites_disabled",
   "org_member_invites_enabled",
   "org_members_exported",
   "org_model_default_updated",
   "org_parent_join_proposal_created",
   "org_parent_search_performed",
   "org_sso_add_initiated",
   "org_sso_connection_activated",
   "org_sso_connection_deactivated",
   "org_sso_connection_deleted",
   "org_sso_group_role_mappings_updated",
   "org_sso_provisioning_mode_changed",
   "org_sso_scim_welcome_email_toggled",
   "org_sso_seat_tier_assignment_toggled",
   "org_sso_seat_tier_mappings_updated",
   "org_sso_toggled",
   "org_sync_deleting_synchronized_files_started",
   "org_sync_synchronized_files_deleted",
   "org_taint_added",
   "org_taint_removed",
   "org_user_deleted",
   "org_user_invite_accepted",
   "org_user_invite_deleted",
   "org_user_invite_re_sent",
   "org_user_invite_rejected",
   "org_user_invite_sent",
   "org_user_left",
   "org_user_shares_retained",
   "org_user_trusted_devices_revoked",
   "org_user_viewed",
   "org_users_listed",
   "org_work_across_apps_disabled",
   "org_work_across_apps_enabled",
   "organization_address_updated",
   "organization_icon_deleted",
   "organization_icon_updated",
   "owned_projects_access_restored",
   "payment_method_updated",
   "pending_share_created",
   "pending_share_revoked",
   "phone_code_sent",
   "phone_code_verified",
   "platform_agent_archived",
   "platform_agent_created",
   "platform_agent_deleted",
   "platform_agent_deployment_archived",
   "platform_agent_deployment_created",
   "platform_agent_deployment_deleted",
   "platform_agent_deployment_paused",
   "platform_agent_deployment_run_triggered",
   "platform_agent_deployment_unpaused",
   "platform_agent_deployment_updated",
   "platform_agent_session_archived",
   "platform_agent_session_created",
   "platform_agent_session_deleted",
   "platform_agent_session_resource_added",
   "platform_agent_session_resource_deleted",
   "platform_agent_session_resource_updated",
   "platform_agent_session_thread_archived",
   "platform_agent_session_updated",
   "platform_agent_updated",
   "platform_api_key_created",
   "platform_api_key_updated",
   "platform_app_attest_authentication",
   "platform_billing_upgraded_to_prepaid",
   "platform_clearance_workspace_program_request_cleared",
   "platform_clearance_workspace_program_request_set",
   "platform_cost_report_viewed",
   "platform_dream_archived",
   "platform_dream_cancelled",
   "platform_dream_created",
   "platform_federated_authentication",
   "platform_federation_issuer_archived",
   "platform_federation_issuer_created",
   "platform_federation_issuer_updated",
   "platform_federation_rule_archived",
   "platform_federation_rule_created",
   "platform_federation_rule_updated",
   "platform_federation_rule_workspace_added",
   "platform_federation_rule_workspace_removed",
   "platform_file_content_downloaded",
   "platform_file_deleted",
   "platform_file_uploaded",
   "platform_memory_created",
   "platform_memory_deleted",
   "platform_memory_store_archived",
   "platform_memory_store_created",
   "platform_memory_store_deleted",
   "platform_memory_store_updated",
   "platform_memory_updated",
   "platform_memory_version_redacted",
   "platform_oauth_app_created",
   "platform_oauth_app_revoked",
   "platform_oauth_app_updated",
   "platform_plugin_directory_submission_created",
   "platform_plugin_directory_submission_deleted",
   "platform_plugin_directory_submission_updated",
   "platform_service_account_archived",
   "platform_service_account_created",
   "platform_service_account_updated",
   "platform_service_account_workspace_member_added",
   "platform_service_account_workspace_member_removed",
   "platform_service_account_workspace_member_updated",
   "platform_signing_key_created",
   "platform_signing_key_deleted",
   "platform_signing_key_rotated",
   "platform_skill_version_content_downloaded",
   "platform_skill_version_created",
   "platform_skill_version_deleted",
   "platform_spend_limit_alert_emails_updated",
   "platform_spend_limit_created",
   "platform_spend_limit_deleted",
   "platform_spend_limit_updated",
   "platform_usage_report_claude_code_viewed",
   "platform_usage_report_messages_viewed",
   "platform_workspace_archived",
   "platform_workspace_created",
   "platform_workspace_inference_data_retention_disabled",
   "platform_workspace_inference_data_retention_enabled",
   "platform_workspace_member_added",
   "platform_workspace_member_removed",
   "platform_workspace_member_updated",
   "platform_workspace_member_viewed",
   "platform_workspace_members_listed",
   "platform_workspace_rate_limit_deleted",
   "platform_workspace_rate_limit_updated",
   "platform_workspace_updated",
   "plugin_installation_preference_updated",
   "prepaid_auto_recharge_disabled",
   "prepaid_auto_recharge_updated",
   "prepaid_extra_usage_auto_reload_disabled",
   "prepaid_extra_usage_auto_reload_enabled",
   "prepaid_extra_usage_auto_reload_settings_updated",
   "primary_owner_transferred",
   "rbac_role_assigned",
   "rbac_role_created",
   "rbac_role_deleted",
   "rbac_role_grant_updated",
   "rbac_role_permission_added",
   "rbac_role_permission_removed",
   "rbac_role_unassigned",
   "rbac_role_updated",
   "role_assignment_granted",
   "role_assignment_revoked",
   "scim_user_created",
   "scim_user_deleted",
   "scim_user_updated",
   "scoped_api_key_deleted",
   "scoped_api_key_updated",
   "seat_tier_changes_cancelled",
   "seat_tiers_purchased",
   "service_created",
   "service_deleted",
   "service_key_created",
   "service_key_revoked",
   "session_revoked",
   "session_share_accessed",
   "session_share_created",
   "session_share_revoked",
   "slack_workspace_claim_revoked",
   "slack_workspace_claimed",
   "social_login_succeeded",
   "sso_login_failed",
   "sso_login_initiated",
   "sso_login_succeeded",
   "sso_second_factor_magic_link",
   "step_up_authentication_failed",
   "step_up_authentication_succeeded",
   "step_up_credential_enrolled",
   "subscription_cancellation_scheduled",
   "subscription_quantity_updated",
   "subscription_renewed",
   "subscription_resumed",
   "subscription_started",
   "subscription_upgraded",
   "trusted_device_credential_rotated",
   "trusted_device_enrolled",
   "trusted_device_revoked",
   "tunnel_archived",
   "tunnel_certificate_added",
   "tunnel_certificate_revoked",
   "tunnel_created",
   "tunnel_token_minted",
   "tunnel_token_revealed",
   "tunnel_token_revoked",
   "tunnel_token_rotated",
   "user_consent_recorded",
   "user_consent_revoked",
   "user_logged_out",
   "verification_evidence_submitted",
   "verification_program_application_created",
   "workspace_member_spend_limit_created",
   "workspace_member_spend_limit_deleted",
   "workspace_member_spend_limit_updated",
   "workspace_spend_limit_alert_emails_updated",
   "workspace_spend_limit_created",
   "workspace_spend_limit_deleted"
  ],
  "description": "Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "enum_count": 506,
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "actor_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter activities by actor IDs (currently only `user_...` IDs are supported). Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination cursor for retrieving the next page of results. To paginate, pass the `last_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "before_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination cursor for retrieving the previous page of results. To paginate, pass the `first_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "created_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "created_at.gt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter activities created after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "created_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter activities created at or after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "created_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter activities created before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "created_at.lte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter activities created at or before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "exclude_activity_types[]",
  "location": "query",
  "type": "array of \"abuse_decision_received\" or \"account_deleted\" or \"admin_api_key_created\" or 503 more",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "abuse_decision_received",
   "account_deleted",
   "admin_api_key_created",
   "admin_api_key_deleted",
   "admin_api_key_updated",
   "admin_connector_request_resolved",
   "admin_request_created",
   "admin_setup_checklist_step_delegated",
   "admin_setup_checklist_step_delegation_cancelled",
   "age_verified",
   "anonymous_mobile_login_attempted",
   "api_key_created",
   "audit_log_export_accessed",
   "audit_log_export_started",
   "billing_emails_updated",
   "ccr_agent_created",
   "ccr_agent_deleted",
   "ccr_agent_proxy_anthropic_oidc_token_exchanged",
   "ccr_agent_proxy_anthropic_oidc_token_minted",
   "ccr_agent_proxy_credential_created",
   "ccr_agent_proxy_credential_deleted",
   "ccr_agent_proxy_credential_rotated",
   "ccr_agent_proxy_credential_updated",
   "ccr_agent_proxy_destination_deleted",
   "ccr_agent_proxy_network_events_listed",
   "ccr_agent_proxy_profile_bound",
   "ccr_agent_proxy_profile_created",
   "ccr_agent_proxy_profile_deleted",
   "ccr_agent_proxy_profile_unbound",
   "ccr_agent_proxy_profile_updated",
   "ccr_agent_proxy_provisioning_credential_rejected",
   "ccr_agent_proxy_provisioning_link_enabled",
   "ccr_agent_proxy_provisioning_link_generated",
   "ccr_agent_proxy_provisioning_link_revoked",
   "ccr_agent_proxy_provisioning_link_submitted",
   "ccr_agent_proxy_rule_created",
   "ccr_agent_proxy_rule_deleted",
   "ccr_agent_proxy_rule_updated",
   "ccr_agent_slack_access_scope_created",
   "ccr_agent_slack_access_scope_deleted",
   "ccr_agent_slack_binding_created",
   "ccr_agent_slack_binding_deleted",
   "ccr_agent_updated",
   "ccr_channel_manager_added",
   "ccr_channel_manager_removed",
   "ccr_role_channel_assignment_deleted",
   "ccr_role_channel_assignment_updated",
   "ccr_session_created",
   "ccr_session_deleted",
   "ccr_session_updated",
   "ccr_slack_channel_joined",
   "claude_artifact_access_failed",
   "claude_artifact_commented",
   "claude_artifact_comments_viewed",
   "claude_artifact_created",
   "claude_artifact_duplicated",
   "claude_artifact_external_sharing_permission_updated",
   "claude_artifact_published",
   "claude_artifact_sharing_updated",
   "claude_artifact_viewed",
   "claude_chat_access_failed",
   "claude_chat_created",
   "claude_chat_deleted",
   "claude_chat_deletion_failed",
   "claude_chat_settings_updated",
   "claude_chat_snapshot_created",
   "claude_chat_snapshot_deleted",
   "claude_chat_snapshot_viewed",
   "claude_chat_sync_source_created",
   "claude_chat_sync_source_deleted",
   "claude_chat_sync_source_updated",
   "claude_chat_updated",
   "claude_chat_viewed",
   "claude_code_credential_revoked",
   "claude_code_review_config_updated",
   "claude_code_review_repository_added",
   "claude_code_review_repository_removed",
   "claude_code_review_repository_updated",
   "claude_code_runner_deleted",
   "claude_code_runner_pool_created",
   "claude_code_runner_pool_deleted",
   "claude_code_runner_pool_secret_minted",
   "claude_code_runner_pool_session_queue_updated",
   "claude_code_runner_pool_updated",
   "claude_code_security_center_config_updated",
   "claude_code_security_scan_cancelled",
   "claude_code_security_scan_created",
   "claude_code_security_scan_project_member_updated",
   "claude_code_security_scan_project_updated",
   "claude_code_security_scan_project_visibility_updated",
   "claude_code_security_scan_run_updated",
   "claude_code_security_scan_schedule_deleted",
   "claude_code_security_scan_schedule_updated",
   "claude_code_security_vulnerability_deleted",
   "claude_code_security_vulnerability_fix_session_created",
   "claude_code_security_vulnerability_updated",
   "claude_code_security_webhook_created",
   "claude_code_security_webhook_deleted",
   "claude_code_security_webhook_secret_updated",
   "claude_code_security_webhook_updated",
   "claude_code_team_memory_acl_updated",
   "claude_code_team_memory_updated",
   "claude_code_team_onboarding_guide_updated",
   "claude_code_user_marketplaces_updated",
   "claude_code_user_memory_updated",
   "claude_code_user_plugins_updated",
   "claude_code_user_settings_updated",
   "claude_command_created",
   "claude_command_deleted",
   "claude_command_replaced",
   "claude_enterprise_upgrade_credit_updated",
   "claude_file_access_failed",
   "claude_file_deleted",
   "claude_file_exported",
   "claude_file_uploaded",
   "claude_file_viewed",
   "claude_gdrive_integration_created",
   "claude_gdrive_integration_deleted",
   "claude_gdrive_integration_updated",
   "claude_github_integration_created",
   "claude_github_integration_deleted",
   "claude_github_integration_updated",
   "claude_organization_settings_updated",
   "claude_plugin_created",
   "claude_plugin_deleted",
   "claude_plugin_disabled",
   "claude_plugin_enabled",
   "claude_plugin_replaced",
   "claude_plugin_security_scan_completed",
   "claude_plugin_updated",
   "claude_project_archived",
   "claude_project_created",
   "claude_project_deleted",
   "claude_project_document_access_failed",
   "claude_project_document_bulk_deletion_audit_truncated",
   "claude_project_document_deleted",
   "claude_project_document_deletion_failed",
   "claude_project_document_updated",
   "claude_project_document_uploaded",
   "claude_project_document_viewed",
   "claude_project_file_access_failed",
   "claude_project_file_bulk_deletion_audit_truncated",
   "claude_project_file_deleted",
   "claude_project_file_deletion_failed",
   "claude_project_file_uploaded",
   "claude_project_reported",
   "claude_project_sharing_updated",
   "claude_project_sync_source_created",
   "claude_project_sync_source_deleted",
   "claude_project_sync_source_updated",
   "claude_project_viewed",
   "claude_published_artifact_deleted",
   "claude_pubsec_identity_configured",
   "claude_skill_created",
   "claude_skill_deleted",
   "claude_skill_disabled",
   "claude_skill_enabled",
   "claude_skill_replaced",
   "claude_skill_security_scan_completed",
   "claude_user_role_updated",
   "claude_user_seat_tier_updated",
   "claude_user_settings_updated",
   "cli_plugin_exec_policy_updated",
   "compliance_api_accessed",
   "cowork_session_updated",
   "design_project_artifact_published",
   "design_project_created",
   "design_project_deleted",
   "design_project_member_added",
   "design_project_member_removed",
   "design_project_member_role_updated",
   "design_project_published",
   "design_project_sharing_updated",
   "design_project_unpublished",
   "design_project_updated",
   "design_project_version_restored",
   "design_project_viewed",
   "desktop_extension_allowlisted",
   "desktop_extension_blocklisted",
   "desktop_extension_deleted",
   "desktop_extension_removed_from_allowlist",
   "desktop_extension_unblocked",
   "desktop_extension_uploaded",
   "desktop_extension_version_uploaded",
   "domain_claim_initiated",
   "end_user_invite_requested",
   "extra_usage_billing_enabled",
   "extra_usage_credit_granted",
   "extra_usage_spend_limit_created",
   "extra_usage_spend_limit_deleted",
   "extra_usage_spend_limit_increase_request_approved",
   "extra_usage_spend_limit_increase_request_denied",
   "extra_usage_spend_limit_updated",
   "ghe_configuration_created",
   "ghe_configuration_deleted",
   "ghe_configuration_updated",
   "ghe_user_connected",
   "ghe_user_disconnected",
   "ghe_webhook_signature_invalid",
   "github_app_installation_linked",
   "github_app_installation_unlinked",
   "github_token_import",
   "group_created",
   "group_deleted",
   "group_list_viewed",
   "group_member_added",
   "group_member_addition_failed",
   "group_member_list_viewed",
   "group_member_removal_failed",
   "group_member_removed",
   "group_project_shares_revoked",
   "group_skill_shares_revoked",
   "group_updated",
   "group_viewed",
   "group_visibility_updated",
   "inference_hooks_circuit_breaker_tripped",
   "inference_hooks_config_deleted",
   "inference_hooks_config_updated",
   "inference_hooks_request_denied",
   "inference_hooks_request_failed_open",
   "inference_hooks_signing_secret_generated",
   "integration_user_connected",
   "integration_user_disconnected",
   "invoice_collection_method_updated",
   "lti_launch_initiated",
   "lti_launch_success",
   "lti_platform_created",
   "lti_platform_updated",
   "magic_link_login_failed",
   "magic_link_login_initiated",
   "magic_link_login_succeeded",
   "managed_organization_setup_completed",
   "marketplace_created",
   "marketplace_deleted",
   "marketplace_updated",
   "marketplace_webhook_deleted",
   "marketplace_webhook_provisioned",
   "mcp_directory_server_published",
   "mcp_server_created",
   "mcp_server_deleted",
   "mcp_server_managed_auth_token_exchanged",
   "mcp_server_managed_auth_updated",
   "mcp_server_updated",
   "mcp_tool_policy_updated",
   "org_analytics_api_capability_updated",
   "org_bulk_delete_initiated",
   "org_capability_grant_added",
   "org_capability_grant_removed",
   "org_claude_code_data_sharing_disabled",
   "org_claude_code_data_sharing_enabled",
   "org_claude_code_desktop_disabled",
   "org_claude_code_desktop_enabled",
   "org_claude_code_zero_data_retention_disabled",
   "org_compliance_api_settings_updated",
   "org_connector_domain_guard_updated",
   "org_cowork_act_without_asking_mode_disabled",
   "org_cowork_act_without_asking_mode_enabled",
   "org_cowork_agent_disabled",
   "org_cowork_agent_enabled",
   "org_cowork_auto_mode_disabled",
   "org_cowork_auto_mode_enabled",
   "org_cowork_browser_pane_disabled",
   "org_cowork_browser_pane_enabled",
   "org_cowork_disabled",
   "org_cowork_enabled",
   "org_cowork_mcp_always_allow_disabled",
   "org_cowork_mcp_always_allow_enabled",
   "org_cowork_otlp_settings_updated",
   "org_cowork_remote_disabled",
   "org_cowork_remote_enabled",
   "org_creation_blocked",
   "org_data_export_accessed",
   "org_data_export_completed",
   "org_data_export_started",
   "org_data_residency_updated",
   "org_deleted_via_bulk",
   "org_deletion_requested",
   "org_directory_resync_completed",
   "org_directory_resync_failed",
   "org_directory_resync_started",
   "org_directory_sync_activated",
   "org_directory_sync_add_initiated",
   "org_directory_sync_deleted",
   "org_discoverability_disabled",
   "org_discoverability_enabled",
   "org_discoverability_settings_updated",
   "org_domain_add_initiated",
   "org_domain_removed",
   "org_domain_verified",
   "org_external_key_created",
   "org_external_key_deleted",
   "org_external_key_updated",
   "org_external_key_validated",
   "org_hipaa_self_serve_enabled",
   "org_invite_link_disabled",
   "org_invite_link_generated",
   "org_invite_link_regenerated",
   "org_invite_viewed",
   "org_invites_listed",
   "org_ip_restriction_created",
   "org_ip_restriction_deleted",
   "org_ip_restriction_updated",
   "org_join_proposal_decided",
   "org_join_request_approved",
   "org_join_request_created",
   "org_join_request_dismissed",
   "org_join_request_instant_approved",
   "org_join_requests_bulk_dismissed",
   "org_magic_link_second_factor_toggled",
   "org_member_invites_disabled",
   "org_member_invites_enabled",
   "org_members_exported",
   "org_model_default_updated",
   "org_parent_join_proposal_created",
   "org_parent_search_performed",
   "org_sso_add_initiated",
   "org_sso_connection_activated",
   "org_sso_connection_deactivated",
   "org_sso_connection_deleted",
   "org_sso_group_role_mappings_updated",
   "org_sso_provisioning_mode_changed",
   "org_sso_scim_welcome_email_toggled",
   "org_sso_seat_tier_assignment_toggled",
   "org_sso_seat_tier_mappings_updated",
   "org_sso_toggled",
   "org_sync_deleting_synchronized_files_started",
   "org_sync_synchronized_files_deleted",
   "org_taint_added",
   "org_taint_removed",
   "org_user_deleted",
   "org_user_invite_accepted",
   "org_user_invite_deleted",
   "org_user_invite_re_sent",
   "org_user_invite_rejected",
   "org_user_invite_sent",
   "org_user_left",
   "org_user_shares_retained",
   "org_user_trusted_devices_revoked",
   "org_user_viewed",
   "org_users_listed",
   "org_work_across_apps_disabled",
   "org_work_across_apps_enabled",
   "organization_address_updated",
   "organization_icon_deleted",
   "organization_icon_updated",
   "owned_projects_access_restored",
   "payment_method_updated",
   "pending_share_created",
   "pending_share_revoked",
   "phone_code_sent",
   "phone_code_verified",
   "platform_agent_archived",
   "platform_agent_created",
   "platform_agent_deleted",
   "platform_agent_deployment_archived",
   "platform_agent_deployment_created",
   "platform_agent_deployment_deleted",
   "platform_agent_deployment_paused",
   "platform_agent_deployment_run_triggered",
   "platform_agent_deployment_unpaused",
   "platform_agent_deployment_updated",
   "platform_agent_session_archived",
   "platform_agent_session_created",
   "platform_agent_session_deleted",
   "platform_agent_session_resource_added",
   "platform_agent_session_resource_deleted",
   "platform_agent_session_resource_updated",
   "platform_agent_session_thread_archived",
   "platform_agent_session_updated",
   "platform_agent_updated",
   "platform_api_key_created",
   "platform_api_key_updated",
   "platform_app_attest_authentication",
   "platform_billing_upgraded_to_prepaid",
   "platform_clearance_workspace_program_request_cleared",
   "platform_clearance_workspace_program_request_set",
   "platform_cost_report_viewed",
   "platform_dream_archived",
   "platform_dream_cancelled",
   "platform_dream_created",
   "platform_federated_authentication",
   "platform_federation_issuer_archived",
   "platform_federation_issuer_created",
   "platform_federation_issuer_updated",
   "platform_federation_rule_archived",
   "platform_federation_rule_created",
   "platform_federation_rule_updated",
   "platform_federation_rule_workspace_added",
   "platform_federation_rule_workspace_removed",
   "platform_file_content_downloaded",
   "platform_file_deleted",
   "platform_file_uploaded",
   "platform_memory_created",
   "platform_memory_deleted",
   "platform_memory_store_archived",
   "platform_memory_store_created",
   "platform_memory_store_deleted",
   "platform_memory_store_updated",
   "platform_memory_updated",
   "platform_memory_version_redacted",
   "platform_oauth_app_created",
   "platform_oauth_app_revoked",
   "platform_oauth_app_updated",
   "platform_plugin_directory_submission_created",
   "platform_plugin_directory_submission_deleted",
   "platform_plugin_directory_submission_updated",
   "platform_service_account_archived",
   "platform_service_account_created",
   "platform_service_account_updated",
   "platform_service_account_workspace_member_added",
   "platform_service_account_workspace_member_removed",
   "platform_service_account_workspace_member_updated",
   "platform_signing_key_created",
   "platform_signing_key_deleted",
   "platform_signing_key_rotated",
   "platform_skill_version_content_downloaded",
   "platform_skill_version_created",
   "platform_skill_version_deleted",
   "platform_spend_limit_alert_emails_updated",
   "platform_spend_limit_created",
   "platform_spend_limit_deleted",
   "platform_spend_limit_updated",
   "platform_usage_report_claude_code_viewed",
   "platform_usage_report_messages_viewed",
   "platform_workspace_archived",
   "platform_workspace_created",
   "platform_workspace_inference_data_retention_disabled",
   "platform_workspace_inference_data_retention_enabled",
   "platform_workspace_member_added",
   "platform_workspace_member_removed",
   "platform_workspace_member_updated",
   "platform_workspace_member_viewed",
   "platform_workspace_members_listed",
   "platform_workspace_rate_limit_deleted",
   "platform_workspace_rate_limit_updated",
   "platform_workspace_updated",
   "plugin_installation_preference_updated",
   "prepaid_auto_recharge_disabled",
   "prepaid_auto_recharge_updated",
   "prepaid_extra_usage_auto_reload_disabled",
   "prepaid_extra_usage_auto_reload_enabled",
   "prepaid_extra_usage_auto_reload_settings_updated",
   "primary_owner_transferred",
   "rbac_role_assigned",
   "rbac_role_created",
   "rbac_role_deleted",
   "rbac_role_grant_updated",
   "rbac_role_permission_added",
   "rbac_role_permission_removed",
   "rbac_role_unassigned",
   "rbac_role_updated",
   "role_assignment_granted",
   "role_assignment_revoked",
   "scim_user_created",
   "scim_user_deleted",
   "scim_user_updated",
   "scoped_api_key_deleted",
   "scoped_api_key_updated",
   "seat_tier_changes_cancelled",
   "seat_tiers_purchased",
   "service_created",
   "service_deleted",
   "service_key_created",
   "service_key_revoked",
   "session_revoked",
   "session_share_accessed",
   "session_share_created",
   "session_share_revoked",
   "slack_workspace_claim_revoked",
   "slack_workspace_claimed",
   "social_login_succeeded",
   "sso_login_failed",
   "sso_login_initiated",
   "sso_login_succeeded",
   "sso_second_factor_magic_link",
   "step_up_authentication_failed",
   "step_up_authentication_succeeded",
   "step_up_credential_enrolled",
   "subscription_cancellation_scheduled",
   "subscription_quantity_updated",
   "subscription_renewed",
   "subscription_resumed",
   "subscription_started",
   "subscription_upgraded",
   "trusted_device_credential_rotated",
   "trusted_device_enrolled",
   "trusted_device_revoked",
   "tunnel_archived",
   "tunnel_certificate_added",
   "tunnel_certificate_revoked",
   "tunnel_created",
   "tunnel_token_minted",
   "tunnel_token_revealed",
   "tunnel_token_revoked",
   "tunnel_token_rotated",
   "user_consent_recorded",
   "user_consent_revoked",
   "user_logged_out",
   "verification_evidence_submitted",
   "verification_program_application_created",
   "workspace_member_spend_limit_created",
   "workspace_member_spend_limit_deleted",
   "workspace_member_spend_limit_updated",
   "workspace_spend_limit_alert_emails_updated",
   "workspace_spend_limit_created",
   "workspace_spend_limit_deleted"
  ],
  "description": "Exclude activities of these types. Cannot be combined with `activity_types[]`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "enum_count": 506,
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "100",
  "minimum": 1,
  "maximum": 5000,
  "enum": null,
  "description": "Maximum results (default: 100, max: 5000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction by `created_at`. `desc` (default) returns newest-first; `asc` returns oldest-first for incremental sync. Activities become queryable after a short asynchronous ingestion delay. When using `asc` with `after_id` for incremental sync, late-arriving rows with timestamps behind the cursor will be skipped; consumers that need at-least-once delivery should periodically re-poll an overlap window via `created_at.gte` and deduplicate by `id`. `after_id` and `before_id` are relative to this order.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "organization_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter activities by organization IDs (accepts `org_...` or organization UUID). Enumerate IDs via `GET /v1/compliance/organizations`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/activities",
  "parameter": "user_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Alias for `actor_ids[]`, for consistency with other compliance routes. If both are provided, the lists are merged.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/activities/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/artifacts/{artifact_version_id}/content",
  "parameter": "artifact_version_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The artifact version ID (tagged ID, e.g., claude_artifact_version_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/artifacts/download",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/artifacts/{artifact_version_id}",
  "parameter": "artifact_version_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The artifact version ID (tagged ID, e.g., claude_artifact_version_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/artifacts/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/compliance/apps/chats/{claude_chat_id}",
  "parameter": "claude_chat_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The chat ID (tagged ID, e.g., claude_chat_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/delete",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/compliance/apps/chats/files/{claude_file_id}",
  "parameter": "claude_file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file ID (tagged ID, e.g., claude_file_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/files/delete",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/files/{claude_file_id}/content",
  "parameter": "claude_file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file ID (tagged ID, e.g., claude_file_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/files/download",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/files/{claude_file_id}",
  "parameter": "claude_file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file ID (tagged ID, e.g., claude_file_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/files/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}/content",
  "parameter": "claude_gen_file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/download",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/generated-files/{claude_gen_file_id}",
  "parameter": "claude_gen_file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/generated_files/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination cursor for retrieving the next page of results. To paginate, pass the `last_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "before_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination cursor for retrieving the previous page of results. To paginate, pass the `first_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "created_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "created_at.gt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter chats created after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "created_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter chats created at or after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "created_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter chats created before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "created_at.lte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter chats created at or before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "100",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (default: 100, max: 1000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "order_by",
  "location": "query",
  "type": "\"created_at\" or \"updated_at\"",
  "required": false,
  "default": "created_at",
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at",
   "updated_at"
  ],
  "description": "Sort key for results. `created_at` (default) sorts by chat creation time. `updated_at` sorts by last update time and is only supported for org-wide queries (omit user_ids[]). For org-wide queries, any time filter must match the sort key: `created_at.*` filters require `order_by=created_at`, and `updated_at.*` filters require `order_by=updated_at`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "organization_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by organization IDs (accepts `org_...` or organization UUID). Enumerate IDs via `GET /v1/compliance/organizations`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "project_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by project IDs (accepts `claude_proj_...`). Enumerate IDs via `GET /v1/compliance/apps/projects`. Requires user_ids[]; not supported for org-wide queries.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "updated_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "updated_at.gt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter chats updated after this time (RFC 3339 format). Combining updated_at filters with `user_ids[]` is deprecated and will be rejected after 2026-09-22; for updated_at-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "updated_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter chats updated at or after this time (RFC 3339 format). Combining updated_at filters with `user_ids[]` is deprecated and will be rejected after 2026-09-22; for updated_at-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "updated_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter chats updated before this time (RFC 3339 format). Combining updated_at filters with `user_ids[]` is deprecated and will be rejected after 2026-09-22; for updated_at-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "updated_at.lte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter chats updated at or before this time (RFC 3339 format). Combining updated_at filters with `user_ids[]` is deprecated and will be rejected after 2026-09-22; for updated_at-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats",
  "parameter": "user_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to chats created by specific users (max 10 per request). Omit for an org-wide query. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`. Deprecated combination: passing `user_ids[]` together with any `updated_at.*` filter is deprecated and will be rejected after 2026-09-22. For `updated_at`-windowed polling, omit `user_ids[]` and use `order_by=updated_at` with `after_id` pagination.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "claude_chat_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The chat ID (tagged ID, e.g., claude_chat_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "after_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination cursor for retrieving the next page of results. To paginate, pass the `last_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "before_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination cursor for retrieving the previous page of results. To paginate, pass the `first_id` value from the most recent response. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "created_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "created_at.gt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter messages created after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "created_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter messages created at or after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "created_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter messages created before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "created_at.lte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter messages created at or before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (max: 1000). When omitted, the full result set is returned in one response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction for messages within the response. `asc` (the default) returns oldest-first; `desc` returns newest-first.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "tool_result_max_chars",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "10000",
  "minimum": -1,
  "maximum": null,
  "enum": null,
  "description": "Maximum characters returned per tool-result text item. Items longer than this are shortened and the block's `truncated` field is set. Pass -1 to disable the limit.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "tool_use_input_max_chars",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "10000",
  "minimum": -1,
  "maximum": null,
  "enum": null,
  "description": "Maximum characters of JSON-encoded tool input returned per tool_use block. Inputs longer than this are shortened and the block's `truncated` field is set. Pass -1 to disable the limit.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "updated_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "updated_at.gt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter messages updated after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "updated_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter messages updated at or after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "updated_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter messages updated before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/chats/{claude_chat_id}/messages",
  "parameter": "updated_at.lte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter messages updated at or before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/chats/messages/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects/{project_id}/attachments",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The project ID (tagged ID, e.g., claude_proj_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects/{project_id}/attachments",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Maximum results (default: 20, max: 100)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects/{project_id}/attachments",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects/{project_id}/collaborators",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The project ID (tagged ID, e.g., claude_proj_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects/{project_id}/collaborators",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Maximum results (default: 20, max: 100)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects/{project_id}/collaborators",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/collaborators/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/compliance/apps/projects/{project_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The project ID (tagged ID, e.g., claude_proj_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/delete",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/compliance/apps/projects/documents/{document_id}",
  "parameter": "document_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The document ID (tagged ID, e.g., claude_proj_doc_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/delete",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects/documents/{document_id}/metadata",
  "parameter": "document_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The document ID (tagged ID, e.g., claude_proj_doc_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/metadata",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects/documents/{document_id}",
  "parameter": "document_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The document ID (tagged ID, e.g., claude_proj_doc_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/documents/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "created_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "created_at.gt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter projects created after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "created_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter projects created at or after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "created_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter projects created before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "created_at.lte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter projects created at or before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Maximum results (default: 20, max: 100)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "organization_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by organization IDs (accepts `org_...` or organization UUID). Enumerate IDs via `GET /v1/compliance/organizations`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "updated_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "updated_at.gt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter projects updated after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "updated_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter projects updated at or after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "updated_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter projects updated before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "updated_at.lte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter projects updated at or before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects",
  "parameter": "user_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by user IDs. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/projects/{project_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The project ID (tagged ID, e.g., claude_proj_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/projects/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local",
  "parameter": "created_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local",
  "parameter": "created_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only return sessions whose first inference call is at or after this time (RFC 3339; a UTC offset is required).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local",
  "parameter": "created_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only return sessions whose first inference call is strictly before this time (RFC 3339; a UTC offset is required).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "100",
  "minimum": 1,
  "maximum": 500,
  "enum": null,
  "description": "Maximum results (default: 100, max: 500)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local",
  "parameter": "updated_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local",
  "parameter": "updated_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only return sessions whose last inference call is at or after this time (RFC 3339; a UTC offset is required). Combines with `created_at.gte` / `created_at.lt`; the ordering and pagination are unchanged. Use it to poll for sessions that have been active since a previous pass — a session that becomes active later can only enter the result, never leave it.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local/{local_session_id}/messages",
  "parameter": "local_session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local/{local_session_id}/messages",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "100",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (default: 100, max: 1000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local/{local_session_id}/messages",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction. `asc` (oldest-first, default) or `desc`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local/{local_session_id}/messages",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local/{local_session_id}/messages",
  "parameter": "tool_result_max_bytes",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "10000",
  "minimum": -1,
  "maximum": 2147483647,
  "enum": null,
  "description": "Truncate each text item inside a tool result to at most this many bytes (cut on a code-point boundary). Pass `-1` to request the server maximum (approximately 1 MiB); larger values are clamped to it. `0` is not a valid value.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local/{local_session_id}/messages",
  "parameter": "tool_use_input_max_bytes",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "10000",
  "minimum": -1,
  "maximum": 2147483647,
  "enum": null,
  "description": "Truncate each tool-use input to at most this many bytes (cut on a code-point boundary so the result is valid UTF-8). Pass `-1` to request the server maximum (approximately 1 MiB); larger values are clamped to it. `0` is not a valid value.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/local/{local_session_id}",
  "parameter": "local_session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote",
  "parameter": "created_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote",
  "parameter": "created_at.gt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter remote sessions created after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote",
  "parameter": "created_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter remote sessions created at or after this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote",
  "parameter": "created_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter remote sessions created before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote",
  "parameter": "created_at.lte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter remote sessions created at or before this time (RFC 3339 format)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "100",
  "minimum": 1,
  "maximum": 500,
  "enum": null,
  "description": "Maximum results (default: 100, max: 500)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote",
  "parameter": "organization_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to specific child organization identifiers. Omit to enumerate every child organization the key may read.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote",
  "parameter": "user_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to sessions owned by specific users (max 10 per request). Agent-owned sessions are excluded when this filter is set.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages",
  "parameter": "claude_remote_session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The remote session identifier (`cse_...`) to retrieve",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "100",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (default: 100, max: 1000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction. `asc` (oldest-first) or `desc`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages",
  "parameter": "tool_result_max_bytes",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "10000",
  "minimum": -1,
  "maximum": 2147483647,
  "enum": null,
  "description": "Truncate each text item inside a tool result to at most this many bytes (cut on a code-point boundary). Pass `-1` to request the server maximum. `0` is not a valid value.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages",
  "parameter": "tool_use_input_max_bytes",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "10000",
  "minimum": -1,
  "maximum": 2147483647,
  "enum": null,
  "description": "Truncate each tool-use input to at most this many bytes (cut on a code-point boundary so the result is valid UTF-8). Pass `-1` to request the server maximum. `0` is not a valid value.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/compliance/apps/code/artifacts/{artifact_id}",
  "parameter": "artifact_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The Artifact ID (tagged ID, e.g., cart_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/delete",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Maximum results (default: 20, max: 100)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts",
  "parameter": "organization_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by organization IDs (accepts `org_...` or organization UUID, up to 500). Enumerate IDs via `GET /v1/compliance/organizations`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts",
  "parameter": "updated_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts",
  "parameter": "updated_at.gt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only Artifacts updated after this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts",
  "parameter": "updated_at.gte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only Artifacts updated at or after this time (RFC 3339 format). Time filters match an eventually-consistent index and Artifacts published before this field was recorded never match — omit the time filter for compliance-complete enumeration. For incremental export, apply a generous overlap margin between windows and dedupe by `id`: adjacent tiling silently misses items whose index update lagged their publish.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts",
  "parameter": "updated_at.lt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only Artifacts updated before this time (RFC 3339 format). Multiple time operators are AND-ed to the tightest bound. See `updated_at.gte` for the completeness caveat.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts",
  "parameter": "updated_at.lte",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only Artifacts updated at or before this time (RFC 3339 format). See `updated_at.gte` for the completeness caveat.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list",
  "format": "date-time",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts",
  "parameter": "user_ids[]",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by owner user IDs (up to 200). Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}",
  "parameter": "artifact_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The Artifact ID (tagged ID, e.g., cart_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/retrieve_version",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}",
  "parameter": "version_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque version identifier from the Artifact's `versions` list",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/code/artifacts/retrieve_version",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/groups",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "500",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (default: 500, max: 1000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/groups/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/groups",
  "parameter": "name_prefix",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "\"\"",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter groups by name prefix",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/groups/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/groups",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/groups/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/groups/{group_id}/members",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The group ID (tagged ID, e.g., rbac_group_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/groups/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/groups/{group_id}/members",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "500",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (default: 500, max: 1000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/groups/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/groups/{group_id}/members",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/groups/members/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/groups/{group_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The group ID (tagged ID, e.g., rbac_group_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/groups/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "1000",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (default: 1000, max: 1000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/roles",
  "parameter": "org_uuid",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The organization UUID",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/roles",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "500",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (default: 500, max: 1000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/roles",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions",
  "parameter": "org_uuid",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The organization UUID",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The role ID (tagged ID, e.g., rbac_role_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "500",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (default: 500, max: 1000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/roles/{role_id}",
  "parameter": "org_uuid",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The organization UUID",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The role ID (tagged ID, e.g., rbac_role_abc123)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/roles/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{organization_id}/settings",
  "parameter": "organization_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The organization's UUID",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/settings/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/users",
  "parameter": "org_uuid",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The organization UUID",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/users",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "500",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum results (default: 500, max: 1000)",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/compliance/organizations/{org_uuid}/users",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/compliance/organizations/users/list",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/organizations/compliance_settings",
  "parameter": "state.type",
  "location": "body",
  "type": "\"enabled\" | \"disabled\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "enabled",
   "disabled"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/organization/compliance_settings/update",
  "_fragment": "generated/fragments/parameters/anthropic-compliance.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Model whose tokenizer is used (Claude 4.7+/Fable/Mythos tokenizer counts ~30% higher).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "messages",
  "location": "body",
  "type": "array<MessageParam>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Same shape as /v1/messages. image/document blocks must be base64 (url/file sources rejected).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "messages[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant",
   "system"
  ],
  "description": "Turn role.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "messages[].content",
  "location": "body",
  "type": "string|array<ContentBlockParam>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Same content block union as /v1/messages (see anthropic-messages.json).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "system",
  "location": "body",
  "type": "string|array<TextBlockParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "System prompt (counted). Live: +6 tokens for a short system string.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "tools",
  "location": "body",
  "type": "array<MessageCountTokensTool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Client tools (and the advisor tool) are counted; other server tools → 400 'Server tools are not supported in the count_tokens endpoint: web_search_20250305' (live).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "tool_choice",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Counted (live: any adds +92 tokens over auto on haiku 4.5).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/token-counting",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "thinking",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Thinking config (affects count; live enabled/1024 → 40 vs 11 tokens).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "output_config",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "effort / format (json_schema). Live: a small schema added ~140 tokens.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "cache_control",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Accepted but ignored: token counting never uses the cache.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "anthropic-beta",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Optional beta header(s).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Workspace id.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "anthropic-user-profile-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "User profile attribution (user-profiles beta).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "user-profiles-2026-09-04",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/count_tokens",
  "_fragment": "generated/fragments/parameters/anthropic-count-tokens.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents",
  "parameter": "created_at[gte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return agents created at or after this time (inclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents",
  "parameter": "created_at[lte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return agents created at or before this time (inclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Include archived agents in results. Defaults to false.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum results per page. Default 20, maximum 100.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor from a previous response.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model",
  "location": "body",
  "type": "BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model.id",
  "location": "body",
  "type": "BetaManagedAgentsModel",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model.effort",
  "location": "body",
  "type": "\"low\" or \"medium\" or \"high\" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "How hard Claude works on each inference call. Accepts a bare level string (`\"high\"`) or `{\"type\": \"high\"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"low\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"medium\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"high\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"xhigh\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"max\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model.inference_geo",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "model.speed",
  "location": "body",
  "type": "\"standard\" or \"fast\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "standard",
   "fast"
  ],
  "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable name for the agent.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description of what the agent does.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "mcp_servers",
  "location": "body",
  "type": "array of BetaManagedAgentsURLMCPServerParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MCP servers this agent connects to. Maximum 20. Names must be unique within the array. Every server must be referenced by an `mcp_toolset` in `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "mcp_servers[].type",
  "location": "body",
  "type": "\"url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "mcp_servers[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "mcp_servers[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Endpoint URL for the MCP server.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "multiagent",
  "location": "body",
  "type": "BetaManagedAgentsMultiagentParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "multiagent.type",
  "location": "body",
  "type": "\"coordinator\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "multiagent.agents",
  "location": "body",
  "type": "array of BetaManagedAgentsMultiagentRosterEntryParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned `{\"type\":\"agent\",\"id\",\"version\"}` reference, or `{\"type\":\"self\"}` to allow recursive self-invocation. Entries must reference distinct agents (after resolving `self` and string forms); at most one `self`. Referenced agents must exist, must not be archived, and must not themselves have `multiagent` set (depth limit 1).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "multiagent.agents[].type",
  "location": "body",
  "type": "\"agent\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "multiagent.agents[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The `agent` ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "multiagent.agents[].version",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "multiagent.agents[].type",
  "location": "body",
  "type": "\"self\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "multiagent.agents[].type",
  "location": "body",
  "type": "\"advisor\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "multiagent.agents[].model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A Claude model id. The model must be permitted as an advisor for this agent's model — see the sessions/threads/advisor spec.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "skills",
  "location": "body",
  "type": "array of BetaManagedAgentsSkillParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skills available to the agent.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "skills[].type",
  "location": "body",
  "type": "\"anthropic\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the custom skill (e.g., \"skill_01XJ5...\").",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "64"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "skills[].version",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Version to pin. Defaults to latest if omitted.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "64"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "skills[].type",
  "location": "body",
  "type": "\"custom\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "system",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System prompt for the agent.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "maxLength": "100000"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools",
  "location": "body",
  "type": "array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tool configurations available to the agent. Maximum of 128 tools across all toolsets allowed.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].type",
  "location": "body",
  "type": "\"agent_toolset_20260401\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs",
  "location": "body",
  "type": "array of BetaManagedAgentsAgentToolConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-tool configuration overrides.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"bash\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"bash\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"bash\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].enabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether this tool is enabled. Overrides the `default_config` setting.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].permission_policy",
  "location": "body",
  "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permission policy for tool execution.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].permission_policy.type",
  "location": "body",
  "type": "\"always_allow\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].permission_policy.type",
  "location": "body",
  "type": "\"always_ask\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].permission_policy.type",
  "location": "body",
  "type": "\"auto\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"edit\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"edit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"edit\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"read\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"read\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"read\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"write\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"write\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"write\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"glob\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"glob\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"glob\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"grep\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"grep\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"grep\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"web_fetch\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"web_fetch\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"web_fetch\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].allowed_domains",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"docs.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].blocked_domains",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"ads.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].max_content_tokens",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"web_search\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"web_search\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"web_search\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].user_location",
  "location": "body",
  "type": "BetaManagedAgentsUserLocation or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Approximate user location for search result localization.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].user_location.type",
  "location": "body",
  "type": "\"approximate\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Location precision. Only \"approximate\" is supported.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].user_location.city",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "City name.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].user_location.country",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Two-letter ISO 3166-1 country code, uppercase.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].user_location.region",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Region or state name.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].user_location.timezone",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "IANA timezone identifier, e.g. \"America/Los_Angeles\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].default_config",
  "location": "body",
  "type": "BetaManagedAgentsAgentToolsetDefaultConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default configuration for all tools in a toolset.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].default_config.enabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether tools are enabled by default. Defaults to true if not specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].default_config.permission_policy",
  "location": "body",
  "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permission policy for tool execution.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].type",
  "location": "body",
  "type": "\"mcp_toolset\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].mcp_server_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs",
  "location": "body",
  "type": "array of BetaManagedAgentsMCPToolConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-tool configuration overrides.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the MCP tool to configure. 1-128 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].default_config",
  "location": "body",
  "type": "BetaManagedAgentsMCPToolsetDefaultConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default configuration for all tools from an MCP server.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].type",
  "location": "body",
  "type": "\"custom\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description of what the tool does, shown to the agent to help it decide when to use the tool.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].input_schema",
  "location": "body",
  "type": "BetaManagedAgentsCustomToolInputSchema",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON Schema for custom tool input parameters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].input_schema.type",
  "location": "body",
  "type": "\"object\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].input_schema.properties",
  "location": "body",
  "type": "map[unknown] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].input_schema.required",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents/{agent_id}",
  "parameter": "agent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents/{agent_id}",
  "parameter": "version",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agent version. Omit for the most recent version. Must be at least 1 if specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/retrieve",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents/{agent_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "agent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description. Omit to preserve; send empty string or null to clear.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "mcp_servers",
  "location": "body",
  "type": "array of BetaManagedAgentsURLMCPServerParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MCP servers. Full replacement. Omit to preserve; send empty array or `null` to clear. Names must be unique. Maximum 20. Every server must be referenced by an `mcp_toolset` in the agent's resulting `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "mcp_servers[].type",
  "location": "body",
  "type": "\"url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "mcp_servers[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "mcp_servers[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Endpoint URL for the MCP server.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model",
  "location": "body",
  "type": "BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model.id",
  "location": "body",
  "type": "BetaManagedAgentsModel",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model.effort",
  "location": "body",
  "type": "\"low\" or \"medium\" or \"high\" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "How hard Claude works on each inference call. Accepts a bare level string (`\"high\"`) or `{\"type\": \"high\"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"low\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"medium\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"high\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"xhigh\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model.effort.type",
  "location": "body",
  "type": "\"max\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model.inference_geo",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model.speed",
  "location": "body",
  "type": "\"standard\" or \"fast\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "standard",
   "fast"
  ],
  "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multiagent",
  "location": "body",
  "type": "BetaManagedAgentsMultiagentParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multiagent.type",
  "location": "body",
  "type": "\"coordinator\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multiagent.agents",
  "location": "body",
  "type": "array of BetaManagedAgentsMultiagentRosterEntryParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned `{\"type\":\"agent\",\"id\",\"version\"}` reference, or `{\"type\":\"self\"}` to allow recursive self-invocation. Entries must reference distinct agents (after resolving `self` and string forms); at most one `self`. Referenced agents must exist, must not be archived, and must not themselves have `multiagent` set (depth limit 1).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multiagent.agents[].type",
  "location": "body",
  "type": "\"agent\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multiagent.agents[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The `agent` ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multiagent.agents[].version",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multiagent.agents[].type",
  "location": "body",
  "type": "\"self\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multiagent.agents[].type",
  "location": "body",
  "type": "\"advisor\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multiagent.agents[].model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A Claude model id. The model must be permitted as an advisor for this agent's model — see the sessions/threads/advisor spec.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "skills",
  "location": "body",
  "type": "array of BetaManagedAgentsSkillParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skills. Full replacement. Omit to preserve; send empty array or null to clear.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "skills[].type",
  "location": "body",
  "type": "\"anthropic\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the custom skill (e.g., \"skill_01XJ5...\").",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "64"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "skills[].version",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Version to pin. Defaults to latest if omitted.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "64"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "skills[].type",
  "location": "body",
  "type": "\"custom\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "system",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System prompt. Omit to preserve; send empty string or null to clear.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "maxLength": "100000"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools",
  "location": "body",
  "type": "array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tool configurations available to the agent. Full replacement. Omit to preserve; send empty array or null to clear. Maximum of 128 tools across all toolsets allowed.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].type",
  "location": "body",
  "type": "\"agent_toolset_20260401\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs",
  "location": "body",
  "type": "array of BetaManagedAgentsAgentToolConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-tool configuration overrides.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"bash\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"bash\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"bash\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].enabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether this tool is enabled. Overrides the `default_config` setting.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].permission_policy",
  "location": "body",
  "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permission policy for tool execution.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].permission_policy.type",
  "location": "body",
  "type": "\"always_allow\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].permission_policy.type",
  "location": "body",
  "type": "\"always_ask\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].permission_policy.type",
  "location": "body",
  "type": "\"auto\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"edit\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"edit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"edit\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"read\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"read\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"read\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"write\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"write\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"write\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"glob\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"glob\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"glob\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"grep\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"grep\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"grep\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"web_fetch\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"web_fetch\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"web_fetch\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].allowed_domains",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"docs.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].blocked_domains",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"ads.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].max_content_tokens",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].type",
  "location": "body",
  "type": "\"web_search\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "\"web_search\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"web_search\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].user_location",
  "location": "body",
  "type": "BetaManagedAgentsUserLocation or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Approximate user location for search result localization.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].user_location.type",
  "location": "body",
  "type": "\"approximate\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Location precision. Only \"approximate\" is supported.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].user_location.city",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "City name.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].user_location.country",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Two-letter ISO 3166-1 country code, uppercase.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].user_location.region",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Region or state name.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].user_location.timezone",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "IANA timezone identifier, e.g. \"America/Los_Angeles\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].default_config",
  "location": "body",
  "type": "BetaManagedAgentsAgentToolsetDefaultConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default configuration for all tools in a toolset.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].default_config.enabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether tools are enabled by default. Defaults to true if not specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].default_config.permission_policy",
  "location": "body",
  "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permission policy for tool execution.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].type",
  "location": "body",
  "type": "\"mcp_toolset\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].mcp_server_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs",
  "location": "body",
  "type": "array of BetaManagedAgentsMCPToolConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-tool configuration overrides.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].configs[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the MCP tool to configure. 1-128 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].default_config",
  "location": "body",
  "type": "BetaManagedAgentsMCPToolsetDefaultConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default configuration for all tools from an MCP server.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].type",
  "location": "body",
  "type": "\"custom\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description of what the tool does, shown to the agent to help it decide when to use the tool.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].input_schema",
  "location": "body",
  "type": "BetaManagedAgentsCustomToolInputSchema",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON Schema for custom tool input parameters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].input_schema.type",
  "location": "body",
  "type": "\"object\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].input_schema.properties",
  "location": "body",
  "type": "map[unknown] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].input_schema.required",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "version",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The agent's current version, used to prevent concurrent overwrites. Obtain this value from a create or retrieve response. Must be at least 1 if specified. When supplied, the request fails if it does not match the server's current version; omit to apply the update unconditionally.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}/archive",
  "parameter": "agent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/agents/{agent_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents/{agent_id}/versions",
  "parameter": "agent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents/{agent_id}/versions",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum results per page. Default 20, maximum 100.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/versions/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents/{agent_id}/versions",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/agents/{agent_id}/versions",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/agents/versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "created_at[gt]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return runs created strictly after this time (exclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "created_at[gte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return runs created at or after this time (inclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "created_at[lt]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return runs created strictly before this time (exclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "created_at[lte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return runs created at or before this time (inclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "deployment_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter to a specific deployment. Omit to list across all deployments in the workspace. Filtering by a non-existent `deployment_id` returns 200 with empty data.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "has_error",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter: true for runs with non-null `error`, false for runs with non-null `session_id`. Omit for all.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum results per page. Default 20, maximum 1000.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor. Pass `next_page` from the previous response. Invalid or expired cursors return 400.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "trigger_type",
  "location": "query",
  "type": "BetaManagedAgentsTriggerType",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "schedule",
   "manual"
  ],
  "description": "Filter runs by what triggered them. Omit to return all runs.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs/{deployment_run_id}",
  "parameter": "deployment_run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployment_runs/{deployment_run_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployment_runs/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments",
  "parameter": "agent_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by agent ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments",
  "parameter": "created_at[gte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return deployments created at or after this time (inclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments",
  "parameter": "created_at[lte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return deployments created at or before this time (inclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, includes archived deployments. Default: false (exclude archived).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum results per page. Default 20, maximum 100.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments",
  "parameter": "status",
  "location": "query",
  "type": "BetaManagedAgentsDeploymentStatus",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "active",
   "paused"
  ],
  "description": "Filter by status: `active` or `paused`. Omit for both. To include archived deployments, use `include_archived` instead; the two cannot be combined.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "agent",
  "location": "body",
  "type": "string or BetaManagedAgentsAgentParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "agent.type",
  "location": "body",
  "type": "\"agent\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "agent.id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The `agent` ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "agent.version",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "environment_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the `environment` defining the container configuration for sessions created from this deployment.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events",
  "location": "body",
  "type": "array of BetaManagedAgentsDeploymentInitialEventParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Events to send to each session immediately after creation. At least 1, maximum 50.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].type",
  "location": "body",
  "type": "\"user.message\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content",
  "location": "body",
  "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Array of content blocks for the user message.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"image\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source",
  "location": "body",
  "type": "BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Union type for image source variants.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"base64\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The plain text content.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the document (e.g., \"application/pdf\").",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URL of the document to fetch.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source.file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of a previously uploaded file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"document\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source",
  "location": "body",
  "type": "BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Union type for document source variants.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].source.media_type",
  "location": "body",
  "type": "\"text/plain\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the text content. Must be \"text/plain\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].context",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional context about the document for the model.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].title",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The title of the document.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"redacted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].type",
  "location": "body",
  "type": "\"user.define_outcome\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "What the agent should produce. This is the task specification.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].rubric",
  "location": "body",
  "type": "BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rubric for grading the quality of an outcome.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].rubric.type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].rubric.file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the rubric file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].rubric.type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].rubric.content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "maxLength": "262144"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].max_iterations",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Eval→revision cycles before giving up. Default 3, max 20.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].type",
  "location": "body",
  "type": "\"system.message\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "initial_events[].content",
  "location": "body",
  "type": "array of BetaManagedAgentsSystemContentBlock",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System content blocks to append. Text-only.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable name for the deployment.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "budget",
  "location": "body",
  "type": "BetaManagedAgentsBudgetLimit or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "budget.type",
  "location": "body",
  "type": "\"limit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "budget.max_list_cost",
  "location": "body",
  "type": "BetaMonetaryAmount",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A monetary amount in a specific currency.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "budget.max_list_cost.amount",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "budget.max_list_cost.currency",
  "location": "body",
  "type": "BetaCurrency",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description of what the deployment does.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources",
  "location": "body",
  "type": "array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Resources (e.g. repositories, files) to mount into each session's container. Maximum 500.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].type",
  "location": "body",
  "type": "\"github_repository\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Github URL of the repository",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].authorization_token",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].checkout",
  "location": "body",
  "type": "BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Branch or commit to check out. Defaults to the repository's default branch.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].checkout.type",
  "location": "body",
  "type": "\"branch\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].checkout.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Branch name to check out.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].checkout.type",
  "location": "body",
  "type": "\"commit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].checkout.sha",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full commit SHA to check out.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "7",
   "maxLength": "64"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].mount_path",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of a previously uploaded file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].type",
  "location": "body",
  "type": "\"memory_store\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].memory_store_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The memory store ID (memstore_...). Must belong to the caller's organization and workspace.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].access",
  "location": "body",
  "type": "\"read_write\" or \"read_only\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "read_write",
   "read_only"
  ],
  "description": "Access mode for an attached memory store.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "resources[].instructions",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "schedule",
  "location": "body",
  "type": "BetaManagedAgentsScheduleParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "schedule.type",
  "location": "body",
  "type": "\"cron\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "schedule.expression",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., \"0 9 * * 1-5\" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "schedule.timezone",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. IANA timezone identifier (e.g., \"America/Los_Angeles\", \"UTC\"). Validated against the IANA timezone database.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "vault_ids",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Vault IDs for stored credentials the agent can use during sessions created from this deployment. Maximum 50.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments/{deployment_id}",
  "parameter": "deployment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/deployments/{deployment_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "deployment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "agent",
  "location": "body",
  "type": "string or BetaManagedAgentsAgentParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest version, or an `agent` object with both id and version specified. Omit to preserve. Cannot be cleared.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "agent.type",
  "location": "body",
  "type": "\"agent\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "agent.id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The `agent` ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "agent.version",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "budget",
  "location": "body",
  "type": "BetaManagedAgentsBudgetLimit or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "budget.type",
  "location": "body",
  "type": "\"limit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "budget.max_list_cost",
  "location": "body",
  "type": "BetaMonetaryAmount",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A monetary amount in a specific currency.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "budget.max_list_cost.amount",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "budget.max_list_cost.currency",
  "location": "body",
  "type": "BetaCurrency",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description. Omit to preserve; send empty string or null to clear.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "environment_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events",
  "location": "body",
  "type": "array of BetaManagedAgentsDeploymentInitialEventParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].type",
  "location": "body",
  "type": "\"user.message\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content",
  "location": "body",
  "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Array of content blocks for the user message.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"image\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source",
  "location": "body",
  "type": "BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Union type for image source variants.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"base64\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The plain text content.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the document (e.g., \"application/pdf\").",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URL of the document to fetch.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source.file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of a previously uploaded file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"document\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source",
  "location": "body",
  "type": "BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Union type for document source variants.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].source.media_type",
  "location": "body",
  "type": "\"text/plain\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the text content. Must be \"text/plain\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].context",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional context about the document for the model.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].title",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The title of the document.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"redacted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].type",
  "location": "body",
  "type": "\"user.define_outcome\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "What the agent should produce. This is the task specification.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].rubric",
  "location": "body",
  "type": "BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rubric for grading the quality of an outcome.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].rubric.type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].rubric.file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the rubric file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].rubric.type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].rubric.content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "maxLength": "262144"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].max_iterations",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Eval→revision cycles before giving up. Default 3, max 20.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].type",
  "location": "body",
  "type": "\"system.message\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "initial_events[].content",
  "location": "body",
  "type": "array of BetaManagedAgentsSystemContentBlock",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System content blocks to append. Text-only.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources",
  "location": "body",
  "type": "array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].type",
  "location": "body",
  "type": "\"github_repository\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Github URL of the repository",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].authorization_token",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].checkout",
  "location": "body",
  "type": "BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Branch or commit to check out. Defaults to the repository's default branch.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].checkout.type",
  "location": "body",
  "type": "\"branch\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].checkout.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Branch name to check out.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].checkout.type",
  "location": "body",
  "type": "\"commit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].checkout.sha",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full commit SHA to check out.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "7",
   "maxLength": "64"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].mount_path",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of a previously uploaded file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].type",
  "location": "body",
  "type": "\"memory_store\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].memory_store_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The memory store ID (memstore_...). Must belong to the caller's organization and workspace.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].access",
  "location": "body",
  "type": "\"read_write\" or \"read_only\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "read_write",
   "read_only"
  ],
  "description": "Access mode for an attached memory store.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "resources[].instructions",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "schedule",
  "location": "body",
  "type": "BetaManagedAgentsScheduleParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "schedule.type",
  "location": "body",
  "type": "\"cron\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "schedule.expression",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., \"0 9 * * 1-5\" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "schedule.timezone",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. IANA timezone identifier (e.g., \"America/Los_Angeles\", \"UTC\"). Validated against the IANA timezone database.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "vault_ids",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}/archive",
  "parameter": "deployment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}/pause",
  "parameter": "deployment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/pause",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}/pause",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/pause",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}/run",
  "parameter": "deployment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/run",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}/run",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/run",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}/unpause",
  "parameter": "deployment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/unpause",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/deployments/{deployment_id}/unpause",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/deployments/unpause",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/dreams",
  "parameter": "created_at[gt]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return dreams with `created_at` strictly after this timestamp (exclusive lower bound, RFC 3339). Unset applies no lower bound.",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/dreams",
  "parameter": "created_at[lt]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return dreams with `created_at` strictly before this timestamp (exclusive upper bound, RFC 3339). Unset applies no upper bound.",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/dreams",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for include_archived",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/dreams",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for limit",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/dreams",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for page",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/dreams",
  "parameter": "statuses",
  "location": "query",
  "type": "array of BetaDreamStatus",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "pending",
   "running",
   "completed",
   "failed",
   "canceled"
  ],
  "description": "Filter by lifecycle status. Repeat the parameter to match any of multiple statuses. Empty applies no status filter.",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/dreams",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "inputs",
  "location": "body",
  "type": "array of BetaDreamInput",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "inputs[].type",
  "location": "body",
  "type": "\"memory_store\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "inputs[].memory_store_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "inputs[].type",
  "location": "body",
  "type": "\"sessions\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "inputs[].session_ids",
  "location": "body",
  "type": "array of string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "model",
  "location": "body",
  "type": "string or BetaDreamModelConfigParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "model.id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model identifier, e.g. \"claude-opus-5\". 1-256 characters.",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "256"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "model.speed",
  "location": "body",
  "type": "\"standard\" or \"fast\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "standard",
   "fast"
  ],
  "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "instructions",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "output_behavior",
  "location": "body",
  "type": "BetaOutputBehavior",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "output_behavior.type",
  "location": "body",
  "type": "\"create_new\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "output_behavior.type",
  "location": "body",
  "type": "\"update_existing\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "output_behavior.memory_store_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/dreams/{dream_id}",
  "parameter": "dream_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/dreams/{dream_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams/{dream_id}/archive",
  "parameter": "dream_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams/{dream_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams/{dream_id}/cancel",
  "parameter": "dream_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "dreaming-2026-04-21",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/cancel",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/dreams/{dream_id}/cancel",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/dreams/cancel",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Include archived environments in the response",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum number of environments to return",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from previous response for pagination. Pass the `next_page` value from the previous response.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable name for the environment",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "constraints": {
   "maxLength": "256",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config",
  "location": "body",
  "type": "BetaCloudConfigParams or BetaSelfHostedConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment configuration",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.type",
  "location": "body",
  "type": "\"cloud\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.networking",
  "location": "body",
  "type": "BetaUnrestrictedNetwork or BetaLimitedNetworkParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network configuration policy. Omit on update to preserve the existing value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.networking.type",
  "location": "body",
  "type": "\"unrestricted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network policy type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.networking.type",
  "location": "body",
  "type": "\"limited\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network policy type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.networking.allow_mcp_servers",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.networking.allow_package_managers",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.networking.allowed_hosts",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies domains the container can reach.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.packages",
  "location": "body",
  "type": "BetaPackagesParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. Under `limited` networking, requires `networking.allow_package_managers` to be `true`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.packages.type",
  "location": "body",
  "type": "\"packages\"",
  "required": false,
  "default": "packages",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Package configuration type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.packages.apt",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ubuntu/Debian packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.packages.cargo",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rust packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.packages.gem",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ruby packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.packages.go",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Go packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.packages.npm",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Node.js packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.packages.pip",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Python packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "config.type",
  "location": "body",
  "type": "\"self_hosted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional description of the environment",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-provided metadata key-value pairs",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "scope",
  "location": "body",
  "type": "\"organization\" or \"account\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "organization",
   "account"
  ],
  "description": "The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. API organizations support only 'organization'; 'account' is rejected. If not specified, defaults based on organization type.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/environments/{environment_id}",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/environments/{environment_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config",
  "location": "body",
  "type": "BetaCloudConfigParams or BetaSelfHostedConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated environment configuration",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.type",
  "location": "body",
  "type": "\"cloud\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.networking",
  "location": "body",
  "type": "BetaUnrestrictedNetwork or BetaLimitedNetworkParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network configuration policy. Omit on update to preserve the existing value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.networking.type",
  "location": "body",
  "type": "\"unrestricted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network policy type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.networking.type",
  "location": "body",
  "type": "\"limited\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network policy type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.networking.allow_mcp_servers",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.networking.allow_package_managers",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.networking.allowed_hosts",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies domains the container can reach.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.packages",
  "location": "body",
  "type": "BetaPackagesParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. Under `limited` networking, requires `networking.allow_package_managers` to be `true`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.packages.type",
  "location": "body",
  "type": "\"packages\"",
  "required": false,
  "default": "packages",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Package configuration type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.packages.apt",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ubuntu/Debian packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.packages.cargo",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rust packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.packages.gem",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ruby packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.packages.go",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Go packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.packages.npm",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Node.js packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.packages.pip",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Python packages to install",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "config.type",
  "location": "body",
  "type": "\"self_hosted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment type",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated description of the environment. Omit to preserve; null clears to null; an empty string is stored as an empty string.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-provided metadata key-value pairs. Set a value to null or empty string to delete the key.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated name for the environment",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "constraints": {
   "maxLength": "256",
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "scope",
  "location": "body",
  "type": "\"organization\" or \"account\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "organization",
   "account"
  ],
  "description": "The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/archive",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Maximum number of work items to return",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from previous response for pagination",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work/poll",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/poll",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work/poll",
  "parameter": "block_ms",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "How long to wait for work to arrive before returning. Must be 1-999 in milliseconds. Defaults to non-blocking (returns immediately if no work is available).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/poll",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work/poll",
  "parameter": "reclaim_older_than_ms",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "Reclaim unacknowledged work items older than this many milliseconds. If omitted, uses the default (5000ms).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/poll",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work/poll",
  "parameter": "Anthropic-Worker-ID",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/poll",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work/stats",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/stats",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work/stats",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/stats",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work/{work_id}",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work/{work_id}",
  "parameter": "work_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/environments/{environment_id}/work/{work_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}",
  "parameter": "work_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve existing metadata.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/ack",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/ack",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/ack",
  "parameter": "work_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/ack",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/heartbeat",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/heartbeat",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/heartbeat",
  "parameter": "work_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/heartbeat",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/heartbeat",
  "parameter": "desired_ttl_seconds",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Desired TTL in seconds",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/heartbeat",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/heartbeat",
  "parameter": "expected_last_heartbeat",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Expected last_heartbeat for conditional update (optimistic concurrency). Use literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server's previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn't match.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/heartbeat",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/stop",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/stop",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/stop",
  "parameter": "work_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/stop",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/stop",
  "parameter": "force",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If true, immediately stop work without graceful shutdown",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/stop",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/environments/{environment_id}/work/{work_id}/stop",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/environments/work/stop",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores",
  "parameter": "created_at[gte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only stores whose `created_at` is at or after this time (inclusive). Sent on the wire as `created_at[gte]`.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores",
  "parameter": "created_at[lte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only stores whose `created_at` is at or before this time (inclusive). Sent on the wire as `created_at[lte]`.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When `true`, archived stores are included in the results. Defaults to `false` (archived stores are excluded).",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of stores to return per page. Must be between 1 and 100. Defaults to 20 when omitted.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor (a `page_...` value). Pass the `next_page` value from a previous response to fetch the next page; omit for the first page.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable name for the store. Required; 1–255 characters; no control characters. The mount-path slug under `/mnt/memory/` is derived from this name (lowercased, non-alphanumeric runs collapsed to a hyphen). Names need not be unique within a workspace.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores",
  "parameter": "description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/create",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Not visible to the agent.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/memory_stores/{memory_store_id}",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/memory_stores/{memory_store_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}",
  "parameter": "description",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New description for the store, up to 1024 characters. Pass an empty string to clear it.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/update",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}",
  "parameter": "name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New human-readable name for the store. 1–255 characters; no control characters. Renaming changes the slug used for the store's `mount_path` in sessions created after the update.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/archive",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "depth",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`0` (or omitted) returns all descendants below `path_prefix` (recursive). `1` returns immediate children only; deeper entries roll up as `memory_prefix` items. `depth=1` behaves like `ls`; omitting `depth` behaves like `find`.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of items to return per page. Must be between 1 and 100. Defaults to 20 when omitted. Capped at 20 when `view=full`. Both `memory` and `memory_prefix` items count toward the limit.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor (a `page_...` value). Pass the `next_page` value from a previous response to fetch the next page; omit for the first page.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "path_prefix",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional path prefix filter. Must end with `/` (segment-aligned), e.g., `/notes/`. This value appears in request URLs. Do not include secrets or personally identifiable information.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "view",
  "location": "query",
  "type": "BetaManagedAgentsMemoryView",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "basic",
   "full"
  ],
  "description": "Which projection of each `memory` to return. Defaults to `basic` (content omitted). `full` populates `content` on each item and caps `limit` at 20; use this as the bulk-read path for export and sync.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "view",
  "location": "query",
  "type": "BetaManagedAgentsMemoryView",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "basic",
   "full"
  ],
  "description": "Query parameter for view",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "content",
  "location": "body",
  "type": "string or null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; pass `\"\"` explicitly to create an empty memory.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "path",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Hierarchical path for the new memory, e.g. `/projects/foo/notes.md`. Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, or the Unicode line and paragraph separators (U+2028, U+2029), and must be NFC-normalized. Paths are case-sensitive.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/create",
  "constraints": {
   "minLength": "2",
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "memory_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "expected_content_sha256",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for expected_content_sha256",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "memory_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "view",
  "location": "query",
  "type": "BetaManagedAgentsMemoryView",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "basic",
   "full"
  ],
  "description": "Query parameter for view",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "memory_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "view",
  "location": "query",
  "type": "BetaManagedAgentsMemoryView",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "basic",
   "full"
  ],
  "description": "Query parameter for view",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "content",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update).",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "path",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New path for the memory (a rename). Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, or the Unicode line and paragraph separators (U+2028, U+2029), and must be NFC-normalized. Paths are case-sensitive. The memory's `id` is preserved across renames. Omit to leave the path unchanged.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",
  "constraints": {
   "minLength": "2",
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "precondition",
  "location": "body",
  "type": "BetaManagedAgentsPrecondition",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "precondition.type",
  "location": "body",
  "type": "\"content_sha256\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "precondition.content_sha256",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Expected `content_sha256` of the stored memory (64 lowercase hexadecimal characters). Typically the `content_sha256` returned by a prior read or list call. Because the server applies no content normalization, clients can also compute this locally as the SHA-256 of the UTF-8 content bytes.",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memories/{memory_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memories/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "api_key_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for api_key_id",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "created_at[gte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return versions created at or after this time (inclusive).",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "created_at[lte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return versions created at or before this time (inclusive).",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for limit",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "memory_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for memory_id",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "operation",
  "location": "query",
  "type": "BetaManagedAgentsMemoryVersionOperation",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "created",
   "modified",
   "deleted"
  ],
  "description": "Query parameter for operation",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for page",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "service_account_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for service_account_id",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "session_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for session_id",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "view",
  "location": "query",
  "type": "BetaManagedAgentsMemoryView",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "basic",
   "full"
  ],
  "description": "Query parameter for view",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}",
  "parameter": "memory_version_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}",
  "parameter": "view",
  "location": "query",
  "type": "BetaManagedAgentsMemoryView",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "basic",
   "full"
  ],
  "description": "Query parameter for view",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact",
  "parameter": "memory_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/redact",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact",
  "parameter": "memory_version_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "agent-memory-2026-07-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/redact",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/redact",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "agent_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter sessions created with this agent ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "agent_version",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by agent version. Only applies when `agent_id` is also set.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "created_at[gt]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return sessions created after this time (exclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "created_at[gte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return sessions created at or after this time (inclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "created_at[lt]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return sessions created before this time (exclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "created_at[lte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return sessions created at or before this time (inclusive).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "deployment_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter sessions created by this deployment ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, includes archived sessions. Default: false (exclude archived).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of results to return.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "memory_store_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter sessions whose resources contain a `memory_store` with this memory store ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction for results, ordered by `created_at`. Defaults to `desc` (newest first).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor from a previous response.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "statuses",
  "location": "query",
  "type": "array of \"rescheduling\" or \"running\" or \"idle\" or \"terminated\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "rescheduling",
   "running",
   "idle",
   "terminated"
  ],
  "description": "Filter by session status. Repeat the parameter to match any of multiple statuses.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent",
  "location": "body",
  "type": "string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agent identifier. Accepts the `agent` ID string, which pins the latest version for the session, or an `agent` object with both id and version specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.type",
  "location": "body",
  "type": "\"agent\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The `agent` ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.version",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The specific `agent` version to use. Omit to use the latest version.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.type",
  "location": "body",
  "type": "\"agent_with_overrides\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.mcp_servers",
  "location": "body",
  "type": "array of BetaManagedAgentsURLMCPServerParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement MCP server list. Full replacement: the provided array becomes the MCP servers. Send an empty array to clear; omit to preserve the agent's servers.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.mcp_servers[].type",
  "location": "body",
  "type": "\"url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.mcp_servers[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.mcp_servers[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Endpoint URL for the MCP server.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model",
  "location": "body",
  "type": "BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement model. Accepts the model string, e.g. `claude-opus-5`, or a `model_config` object. Omit to use the agent's model.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model.id",
  "location": "body",
  "type": "BetaManagedAgentsModel",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model.effort",
  "location": "body",
  "type": "\"low\" or \"medium\" or \"high\" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "How hard Claude works on each inference call. Accepts a bare level string (`\"high\"`) or `{\"type\": \"high\"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model.effort.type",
  "location": "body",
  "type": "\"low\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model.effort.type",
  "location": "body",
  "type": "\"medium\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model.effort.type",
  "location": "body",
  "type": "\"high\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model.effort.type",
  "location": "body",
  "type": "\"xhigh\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model.effort.type",
  "location": "body",
  "type": "\"max\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model.inference_geo",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.model.speed",
  "location": "body",
  "type": "\"standard\" or \"fast\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "standard",
   "fast"
  ],
  "description": "Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.skills",
  "location": "body",
  "type": "array of BetaManagedAgentsSkillParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement skill list. Full replacement: the provided array becomes the skills. Send an empty array to clear; omit to preserve the agent's skills.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.skills[].type",
  "location": "body",
  "type": "\"anthropic\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tagged ID of the custom skill (e.g., \"skill_01XJ5...\").",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "64"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.skills[].version",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Version to pin. Defaults to latest if omitted.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "64"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.skills[].type",
  "location": "body",
  "type": "\"custom\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.system",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement system prompt. Up to 100,000 characters. Set to null to clear the agent's system prompt; omit to preserve it.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "maxLength": "100000"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools",
  "location": "body",
  "type": "array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement tool list. Full replacement: the provided array becomes the tool configuration. Send an empty array to clear; omit to preserve the agent's tools.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].type",
  "location": "body",
  "type": "\"agent_toolset_20260401\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs",
  "location": "body",
  "type": "array of BetaManagedAgentsAgentToolConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-tool configuration overrides.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"bash\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"bash\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"bash\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].enabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether this tool is enabled. Overrides the `default_config` setting.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].permission_policy",
  "location": "body",
  "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permission policy for tool execution.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"edit\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"edit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"edit\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"read\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"read\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"read\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"write\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"write\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"write\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"glob\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"glob\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"glob\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"grep\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"grep\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"grep\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"web_fetch\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"web_fetch\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"web_fetch\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].allowed_domains",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"docs.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].blocked_domains",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"ads.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].max_content_tokens",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"web_search\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"web_search\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"web_search\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].user_location",
  "location": "body",
  "type": "BetaManagedAgentsUserLocation or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Approximate user location for search result localization.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].user_location.type",
  "location": "body",
  "type": "\"approximate\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Location precision. Only \"approximate\" is supported.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].user_location.city",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "City name.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].user_location.country",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Two-letter ISO 3166-1 country code, uppercase.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].user_location.region",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Region or state name.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].user_location.timezone",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "IANA timezone identifier, e.g. \"America/Los_Angeles\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].default_config",
  "location": "body",
  "type": "BetaManagedAgentsAgentToolsetDefaultConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default configuration for all tools in a toolset.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].default_config.enabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether tools are enabled by default. Defaults to true if not specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].default_config.permission_policy",
  "location": "body",
  "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permission policy for tool execution.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].type",
  "location": "body",
  "type": "\"mcp_toolset\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].mcp_server_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs",
  "location": "body",
  "type": "array of BetaManagedAgentsMCPToolConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-tool configuration overrides.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the MCP tool to configure. 1-128 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].default_config",
  "location": "body",
  "type": "BetaManagedAgentsMCPToolsetDefaultConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default configuration for all tools from an MCP server.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].type",
  "location": "body",
  "type": "\"custom\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description of what the tool does, shown to the agent to help it decide when to use the tool.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].input_schema",
  "location": "body",
  "type": "BetaManagedAgentsCustomToolInputSchema",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON Schema for custom tool input parameters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].input_schema.type",
  "location": "body",
  "type": "\"object\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].input_schema.properties",
  "location": "body",
  "type": "map[unknown] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].input_schema.required",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "agent.tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "environment_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the `environment` defining the container configuration for this session.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "budget",
  "location": "body",
  "type": "BetaManagedAgentsBudgetLimit",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "budget.type",
  "location": "body",
  "type": "\"limit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "budget.max_list_cost",
  "location": "body",
  "type": "BetaMonetaryAmount",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A monetary amount in a specific currency.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "budget.max_list_cost.amount",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "budget.max_list_cost.currency",
  "location": "body",
  "type": "BetaCurrency",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events",
  "location": "body",
  "type": "array of BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserDefineOutcomeEventParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Initial events to send to the `session` at creation, processed in order. Supports `user.message` and `user.define_outcome` events. Maximum 50 events.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].type",
  "location": "body",
  "type": "\"user.message\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content",
  "location": "body",
  "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Array of content blocks for the user message.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"image\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source",
  "location": "body",
  "type": "BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Union type for image source variants.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"base64\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The plain text content.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the document (e.g., \"application/pdf\").",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URL of the document to fetch.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source.file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of a previously uploaded file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"document\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source",
  "location": "body",
  "type": "BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Union type for document source variants.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source.type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].source.media_type",
  "location": "body",
  "type": "\"text/plain\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the text content. Must be \"text/plain\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].context",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional context about the document for the model.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].title",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The title of the document.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].content[].type",
  "location": "body",
  "type": "\"redacted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].type",
  "location": "body",
  "type": "\"user.define_outcome\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "What the agent should produce. This is the task specification.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].rubric",
  "location": "body",
  "type": "BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rubric for grading the quality of an outcome.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].rubric.type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].rubric.file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the rubric file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].rubric.type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].rubric.content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "maxLength": "262144"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "initial_events[].max_iterations",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Eval→revision cycles before giving up. Default 3, max 20.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources",
  "location": "body",
  "type": "array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Resources (e.g. repositories, files) to mount into the session's container.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].type",
  "location": "body",
  "type": "\"github_repository\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Github URL of the repository",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].authorization_token",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].checkout",
  "location": "body",
  "type": "BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Branch or commit to check out. Defaults to the repository's default branch.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].checkout.type",
  "location": "body",
  "type": "\"branch\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].checkout.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Branch name to check out.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].checkout.type",
  "location": "body",
  "type": "\"commit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].checkout.sha",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full commit SHA to check out.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "7",
   "maxLength": "64"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].mount_path",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of a previously uploaded file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].type",
  "location": "body",
  "type": "\"memory_store\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].memory_store_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The memory store ID (memstore_...). Must belong to the caller's organization and workspace.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].access",
  "location": "body",
  "type": "\"read_write\" or \"read_only\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "read_write",
   "read_only"
  ],
  "description": "Access mode for an attached memory store.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "resources[].instructions",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "title",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable session title.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "constraints": {
   "maxLength": "500"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "vault_ids",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Vault IDs for stored credentials the agent can use during the session.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/sessions/{session_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/sessions/{session_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent",
  "location": "body",
  "type": "BetaManagedAgentsSessionAgentUpdate",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Mid-session agent configuration update. Only `tools` and `mcp_servers` are updatable. Full replacement: the provided array becomes the new value. To preserve existing entries, GET the session, modify the array, and POST it back.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.mcp_servers",
  "location": "body",
  "type": "array of BetaManagedAgentsURLMCPServerParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement MCP server list. Full replacement: the provided array becomes the new value. Send an empty array to clear; omit to preserve.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.mcp_servers[].type",
  "location": "body",
  "type": "\"url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.mcp_servers[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.mcp_servers[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Endpoint URL for the MCP server.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "maxLength": "2048"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools",
  "location": "body",
  "type": "array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement tool list. Full replacement: the provided array becomes the new value. Send an empty array to clear; omit to preserve.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].type",
  "location": "body",
  "type": "\"agent_toolset_20260401\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs",
  "location": "body",
  "type": "array of BetaManagedAgentsAgentToolConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-tool configuration overrides.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"bash\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"bash\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"bash\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].enabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether this tool is enabled. Overrides the `default_config` setting.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].permission_policy",
  "location": "body",
  "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permission policy for tool execution.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"edit\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"edit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"edit\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"read\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"read\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"read\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"write\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"write\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"write\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"glob\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"glob\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"glob\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"grep\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"grep\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"grep\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"web_fetch\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"web_fetch\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"web_fetch\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].allowed_domains",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"docs.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].blocked_domains",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like \"ads.example.com\" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].max_content_tokens",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].type",
  "location": "body",
  "type": "\"web_search\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "\"web_search\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be \"web_search\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].user_location",
  "location": "body",
  "type": "BetaManagedAgentsUserLocation or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Approximate user location for search result localization.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].user_location.type",
  "location": "body",
  "type": "\"approximate\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Location precision. Only \"approximate\" is supported.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].user_location.city",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "City name.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].user_location.country",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Two-letter ISO 3166-1 country code, uppercase.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].user_location.region",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Region or state name.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].user_location.timezone",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "IANA timezone identifier, e.g. \"America/Los_Angeles\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].default_config",
  "location": "body",
  "type": "BetaManagedAgentsAgentToolsetDefaultConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default configuration for all tools in a toolset.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].default_config.enabled",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether tools are enabled by default. Defaults to true if not specified.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].default_config.permission_policy",
  "location": "body",
  "type": "BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permission policy for tool execution.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].type",
  "location": "body",
  "type": "\"mcp_toolset\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].mcp_server_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs",
  "location": "body",
  "type": "array of BetaManagedAgentsMCPToolConfigParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-tool configuration overrides.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].configs[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the MCP tool to configure. 1-128 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].default_config",
  "location": "body",
  "type": "BetaManagedAgentsMCPToolsetDefaultConfigParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default configuration for all tools from an MCP server.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].type",
  "location": "body",
  "type": "\"custom\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description of what the tool does, shown to the agent to help it decide when to use the tool.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].input_schema",
  "location": "body",
  "type": "BetaManagedAgentsCustomToolInputSchema",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON Schema for custom tool input parameters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].input_schema.type",
  "location": "body",
  "type": "\"object\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].input_schema.properties",
  "location": "body",
  "type": "map[unknown] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].input_schema.required",
  "location": "body",
  "type": "array of string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "agent.tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "budget",
  "location": "body",
  "type": "BetaManagedAgentsBudgetLimit or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "budget.type",
  "location": "body",
  "type": "\"limit\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "budget.max_list_cost",
  "location": "body",
  "type": "BetaMonetaryAmount",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A monetary amount in a specific currency.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "budget.max_list_cost.amount",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Amount in minor units of the currency, as an integer decimal string with no leading zeros: \"2500\" is $25.00 and \"50\" is fifty cents. A string rather than a number so no float rounding is ever applied.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "budget.max_list_cost.currency",
  "location": "body",
  "type": "BetaCurrency",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "title",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable session title.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "500"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "vault_ids",
  "location": "body",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Vault IDs (`vlt_*`) to attach to the session. Not yet supported; requests setting this field are rejected. Reserved for future use.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/archive",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "created_at[gt]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return events created after this time (exclusive). Compared against the event's `processed_at` value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "created_at[gte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return events created at or after this time (inclusive). Compared against the event's `processed_at` value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "created_at[lt]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return events created before this time (exclusive). Compared against the event's `processed_at` value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "created_at[lte]",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return events created at or before this time (inclusive). Compared against the event's `processed_at` value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for limit",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort direction for results, ordered by the event's `processed_at`. Defaults to `asc` (chronological).",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor from a previous response's `next_page`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "types",
  "location": "query",
  "type": "array of string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by event type. Values match the `type` field on returned events (for example, `user.message` or `agent.tool_use`). Omit to return all event types.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events",
  "location": "body",
  "type": "array of BetaManagedAgentsEventParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Events to send to the `session`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].type",
  "location": "body",
  "type": "\"user.message\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content",
  "location": "body",
  "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Array of content blocks for the user message.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].type",
  "location": "body",
  "type": "\"image\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source",
  "location": "body",
  "type": "BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Union type for image source variants.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source.type",
  "location": "body",
  "type": "\"base64\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The plain text content.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the document (e.g., \"application/pdf\").",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source.type",
  "location": "body",
  "type": "\"url\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URL of the document to fetch.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source.type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source.file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of a previously uploaded file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].type",
  "location": "body",
  "type": "\"document\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source",
  "location": "body",
  "type": "BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Union type for document source variants.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source.type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source.media_type",
  "location": "body",
  "type": "\"text/plain\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the text content. Must be \"text/plain\".",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].context",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional context about the document for the model.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].title",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The title of the document.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].type",
  "location": "body",
  "type": "\"redacted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].type",
  "location": "body",
  "type": "\"user.interrupt\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].session_thread_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].type",
  "location": "body",
  "type": "\"user.tool_confirmation\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].result",
  "location": "body",
  "type": "\"allow\" or \"deny\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "allow",
   "deny"
  ],
  "description": "UserToolConfirmationResult enum",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].tool_use_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The id of the `agent.tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].deny_message",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "maxLength": "10000"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].type",
  "location": "body",
  "type": "\"user.custom_tool_result\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].custom_tool_use_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content",
  "location": "body",
  "type": "array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The result content returned by the tool.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].type",
  "location": "body",
  "type": "\"search_result\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].citations",
  "location": "body",
  "type": "BetaManagedAgentsSearchResultCitations",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Citation settings for a search result.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].citations.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether citations are enabled for this search result.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].content",
  "location": "body",
  "type": "array of BetaManagedAgentsSearchResultContent",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Array of text content blocks from the search result.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].content[].type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].source",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL source of the search result.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content[].title",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The title of the search result.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "minLength": "1"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].is_error",
  "location": "body",
  "type": "boolean or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the tool execution resulted in an error.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].type",
  "location": "body",
  "type": "\"user.define_outcome\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "What the agent should produce. This is the task specification.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].rubric",
  "location": "body",
  "type": "BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rubric for grading the quality of an outcome.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].rubric.type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].rubric.file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the rubric file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].rubric.type",
  "location": "body",
  "type": "\"text\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].rubric.content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "maxLength": "262144"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].max_iterations",
  "location": "body",
  "type": "number or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Eval→revision cycles before giving up. Default 3, max 20.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].type",
  "location": "body",
  "type": "\"user.tool_result\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].type",
  "location": "body",
  "type": "\"system.message\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "events[].content",
  "location": "body",
  "type": "array of BetaManagedAgentsSystemContentBlock",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System content blocks to append. Text-only.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/events",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/send",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events/stream",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/stream",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events/stream",
  "parameter": "event_deltas",
  "location": "query",
  "type": "array of BetaManagedAgentsDeltaType",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "agent.message",
   "agent.thinking"
  ],
  "description": "When set, this connection also receives streaming deltas (`event_start`, `event_delta`) while an event is being produced, before the event itself arrives. Deltas are best-effort; when the final event is produced it carries the complete content. A model request that ends early (an error or interrupt) produces no final event — its terminal `span.model_request_end` closes the preview. Accepts one or more event types to preview and may be repeated: `agent.message` streams `content_delta` fragments; `agent.thinking` is start-only — a signal that the agent has begun extended thinking, concluded by the `agent.thinking` event itself. Only previews of the requested event types are sent.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/stream",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/events/stream",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/events/stream",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/resources",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/resources",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of resources to return per page (max 1000). If omitted, returns all resources.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/resources",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque cursor from a previous response's `next_page` field.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/resources",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/resources",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/add",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/resources",
  "parameter": "file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of a previously uploaded file.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/add",
  "constraints": {
   "minLength": "1",
   "maxLength": "128"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/resources",
  "parameter": "type",
  "location": "body",
  "type": "\"file\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/add",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/resources",
  "parameter": "mount_path",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/add",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/resources",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/add",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "resource_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "resource_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "resource_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "authorization_token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New authorization token for the resource. Currently only `github_repository` resources support token rotation.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/resources/{resource_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/resources/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum results per page. Defaults to 1000.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor from a previous response's `next_page`. Forward-only.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/threads/{thread_id}/archive",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/threads/{thread_id}/archive",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/sessions/{session_id}/threads/{thread_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}/events",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}/events",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}/events",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for limit",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}/events",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for page",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}/events",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}/stream",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/stream",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}/stream",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/stream",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}/stream",
  "parameter": "event_deltas",
  "location": "query",
  "type": "array of BetaManagedAgentsDeltaType",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "agent.message",
   "agent.thinking"
  ],
  "description": "When set, this connection also receives streaming deltas (`event_start`, `event_delta`) while an event is being produced, before the event itself arrives. Deltas are best-effort; when the final event is produced it carries the complete content. A model request that ends early (an error or interrupt) produces no final event — its terminal `span.model_request_end` closes the preview. Accepts one or more event types to preview and may be repeated: `agent.message` streams `content_delta` fragments; `agent.thinking` is start-only — a signal that the agent has begun extended thinking, concluded by the `agent.thinking` event itself. Only previews of the requested event types are sent.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/stream",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/sessions/{session_id}/threads/{thread_id}/stream",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/sessions/threads/events/stream",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to include archived tunnels in the results. Defaults to false.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of tunnels to return per page. Defaults to 20, maximum 1000.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor from a previous `list_tunnels` response.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels",
  "parameter": "display_name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional human-readable name for the tunnel (1-255 characters).",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/archive",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}/certificates",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}/certificates",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to include archived certificates in the results. Defaults to false.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}/certificates",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of certificates to return per page. Defaults to 20, maximum 1000.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}/certificates",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination cursor from a previous `list_tunnel_certificates` response.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}/certificates",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/certificates",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/certificates",
  "parameter": "ca_certificate_pem",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/create",
  "constraints": {
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/certificates",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}/certificates/{certificate_id}",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}/certificates/{certificate_id}",
  "parameter": "certificate_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/tunnels/{tunnel_id}/certificates/{certificate_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive",
  "parameter": "certificate_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/certificates/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/reveal_token",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/reveal_token",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/reveal_token",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/reveal_token",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/rotate_token",
  "parameter": "tunnel_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/rotate_token",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/rotate_token",
  "parameter": "reason",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional free-text reason for the rotation, recorded for audit.",
  "compatible_models": null,
  "beta_header": "mcp-tunnels-2026-06-22",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/rotate_token",
  "constraints": {
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/tunnels/{tunnel_id}/rotate_token",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/tunnels/rotate_token",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/user_profiles",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for limit",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/user_profiles",
  "parameter": "order",
  "location": "query",
  "type": "\"asc\" or \"desc\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Query parameter for order",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/user_profiles",
  "parameter": "order_by",
  "location": "query",
  "type": "\"created_at\" or \"name\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at",
   "name"
  ],
  "description": "Query parameter for order_by",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/user_profiles",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Query parameter for page",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/user_profiles",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "access_type",
  "location": "body",
  "type": "\"application\" or \"passthrough\"",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "application",
   "passthrough"
  ],
  "description": "How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_user_details",
  "location": "body",
  "type": "BetaUserProfileExternalUserDetailsParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Details about the entity this profile represents, as the platform states them. Every field is optional. Accepted under the `user-profiles-2026-09-04` beta header only.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_user_details.account_status",
  "location": "body",
  "type": "\"active\" or \"suspended\" or \"blocked\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "active",
   "suspended",
   "blocked"
  ],
  "description": "The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_user_details.country",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_user_details.email_hash",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_user_details.entity_type",
  "location": "body",
  "type": "\"individual\" or \"business\" or \"non_profit\" or \"government\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "individual",
   "business",
   "non_profit",
   "government"
  ],
  "description": "What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_user_details.name_hash",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_user_details.onboarded_at",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A timestamp in RFC 3339 format",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_user_details.reference_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "external_user_onboarded_at",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A timestamp in RFC 3339 format",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a company the platform resells Claude access to (`access_type` `passthrough`), that company's name where known. Maximum 255 characters.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/user_profiles/{user_profile_id}",
  "parameter": "user_profile_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/user_profiles/{user_profile_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "user_profile_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "access_type",
  "location": "body",
  "type": "\"application\" or \"passthrough\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "application",
   "passthrough"
  ],
  "description": "How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_user_details",
  "location": "body",
  "type": "BetaUserProfileExternalUserDetailsParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and `null` is rejected. Accepted under the `user-profiles-2026-09-04` beta header only.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_user_details.account_status",
  "location": "body",
  "type": "\"active\" or \"suspended\" or \"blocked\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "active",
   "suspended",
   "blocked"
  ],
  "description": "The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_user_details.country",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_user_details.email_hash",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_user_details.entity_type",
  "location": "body",
  "type": "\"individual\" or \"business\" or \"non_profit\" or \"government\" or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "individual",
   "business",
   "non_profit",
   "government"
  ],
  "description": "What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_user_details.name_hash",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_user_details.onboarded_at",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A timestamp in RFC 3339 format",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_user_details.reference_id",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "external_user_onboarded_at",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A timestamp in RFC 3339 format",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters.",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}/enrollment_url",
  "parameter": "user_profile_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "user-profiles-2026-08-18",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create_enrollment_url",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/user_profiles/{user_profile_id}/enrollment_url",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/user_profiles/create_enrollment_url",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to include archived vaults in the results.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of vaults to return per page. Defaults to 20, maximum 100.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous `list_vaults` response.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults",
  "parameter": "display_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable name for the vault. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Arbitrary key-value metadata to attach to the vault. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/vaults/{vault_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/vaults/{vault_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}",
  "parameter": "display_name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated human-readable name for the vault. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/archive",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to include archived credentials in the results.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of credentials to return per page. Defaults to 20, maximum 100.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/list",
  "constraints": {
   "format": "int32"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque pagination token from a previous `list_credentials` response.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/list",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth",
  "location": "body",
  "type": "BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Authentication details for creating a credential.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.type",
  "location": "body",
  "type": "\"mcp_oauth\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.access_token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OAuth access token.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.mcp_server_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URL of the MCP server this credential authenticates against.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "2047"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.expires_at",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A timestamp in RFC 3339 format",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh",
  "location": "body",
  "type": "BetaManagedAgentsMCPOAuthRefreshParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OAuth refresh token parameters for creating a credential with refresh support.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.client_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OAuth client ID.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "1024"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.refresh_token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OAuth refresh token.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Token endpoint URL used to refresh the access token.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "2047"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint_auth",
  "location": "body",
  "type": "BetaManagedAgentsTokenEndpointAuthNoneParam or BetaManagedAgentsTokenEndpointAuthBasicParam or BetaManagedAgentsTokenEndpointAuthPostParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint_auth.type",
  "location": "body",
  "type": "\"none\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint_auth.type",
  "location": "body",
  "type": "\"client_secret_basic\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint_auth.client_secret",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OAuth client secret.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "512"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint_auth.type",
  "location": "body",
  "type": "\"client_secret_post\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.resource",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OAuth resource indicator.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "2047"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.scope",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OAuth scope for the refresh request.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.type",
  "location": "body",
  "type": "\"static_bearer\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Static bearer token value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.type",
  "location": "body",
  "type": "\"environment_variable\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.networking",
  "location": "body",
  "type": "BetaManagedAgentsCredentialNetworkingParams",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Outbound hosts the secret value is substituted on.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.networking.type",
  "location": "body",
  "type": "\"unrestricted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.networking.type",
  "location": "body",
  "type": "\"limited\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.networking.allowed_hosts",
  "location": "body",
  "type": "array of string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.secret_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the environment variable. Immutable after create.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.secret_value",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Secret value. Write-only; never returned in responses.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.injection_location",
  "location": "body",
  "type": "BetaManagedAgentsInjectionLocationParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Where in the outbound request the secret value may be substituted.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.injection_location.body",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Substitute when the placeholder appears in the request body.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.injection_location.header",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Substitute when the placeholder appears in a request header value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "display_name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable name for the credential. Up to 255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "constraints": {
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Arbitrary key-value metadata to attach to the credential. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/create",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "credential_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/delete",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "credential_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "credential_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth",
  "location": "body",
  "type": "BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated authentication details for a credential.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.type",
  "location": "body",
  "type": "\"mcp_oauth\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.access_token",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated OAuth access token.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.expires_at",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A timestamp in RFC 3339 format",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "constraints": {
   "format": "date-time"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh",
  "location": "body",
  "type": "BetaManagedAgentsMCPOAuthRefreshUpdateParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Parameters for updating OAuth refresh token configuration.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh.refresh_token",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated OAuth refresh token.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh.scope",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated OAuth scope for the refresh request.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "constraints": {
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh.token_endpoint_auth",
  "location": "body",
  "type": "BetaManagedAgentsTokenEndpointAuthBasicUpdateParam or BetaManagedAgentsTokenEndpointAuthPostUpdateParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh.token_endpoint_auth.type",
  "location": "body",
  "type": "\"client_secret_basic\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh.token_endpoint_auth.client_secret",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated OAuth client secret.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "512"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh.token_endpoint_auth.type",
  "location": "body",
  "type": "\"client_secret_post\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.type",
  "location": "body",
  "type": "\"static_bearer\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.token",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated static bearer token value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "8192"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.type",
  "location": "body",
  "type": "\"environment_variable\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.injection_location",
  "location": "body",
  "type": "BetaManagedAgentsInjectionLocationUpdateParams",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated injection location.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.injection_location.body",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Substitute when the placeholder appears in the request body.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.injection_location.header",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Substitute when the placeholder appears in a request header value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.networking",
  "location": "body",
  "type": "BetaManagedAgentsCredentialNetworkingParams or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated networking scope. Full replacement.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.networking.type",
  "location": "body",
  "type": "\"unrestricted\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.networking.type",
  "location": "body",
  "type": "\"limited\"",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.networking.allowed_hosts",
  "location": "body",
  "type": "array of string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.secret_value",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated secret value.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "4096"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "display_name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated human-readable name for the credential. 1-255 characters.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "constraints": {
   "minLength": "1",
   "maxLength": "255"
  },
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map[string] or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved.",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/update",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}/archive",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}/archive",
  "parameter": "credential_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}/archive",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/archive",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/mcp_oauth_validate",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate",
  "parameter": "credential_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "managed-agents-2026-04-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/mcp_oauth_validate",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/vaults/credentials/mcp_oauth_validate",
  "_fragment": "generated/fragments/parameters/anthropic-managed-agents.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Model id or alias (e.g. claude-haiku-4-5-20251001, claude-sonnet-5, claude-fable-5-1). Unknown id → 404 not_found_error 'model: <id>'.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages",
  "location": "body",
  "type": "array<MessageParam>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Input messages; alternating user/assistant turns (consecutive same-role turns are merged). Max 100,000 messages. Empty array → 400 'messages: at least one message is required'.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant",
   "system"
  ],
  "description": "Turn role. `system` appears in the schema but the docs state there is no system role — use top-level `system`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content",
  "location": "body",
  "type": "string|array<ContentBlockParam>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "String shorthand for one text block, or an array of content blocks.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "image",
   "document",
   "search_result",
   "thinking",
   "redacted_thinking",
   "tool_use",
   "tool_result",
   "server_tool_use",
   "web_search_tool_result",
   "web_fetch_tool_result",
   "code_execution_tool_result",
   "bash_code_execution_tool_result",
   "text_editor_code_execution_tool_result",
   "tool_search_tool_result",
   "container_upload"
  ],
  "description": "Discriminator of the request content block.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": [],
  "description": "Text of a `text` block (minLength 1).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].citations",
  "location": "body",
  "type": "array<TextCitationParam>|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Citations attached to a `text` block (char_location, page_location, content_block_location, web_search_result_location, search_result_location). Usually replayed from a prior response.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].cache_control",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Cache control breakpoint at this block. `type` is always `ephemeral`; `ttl` is `5m` (default) or `1h` (1h TTL is GA; the old `extended-cache-ttl-2025-04-11` beta header is no longer required).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].cache_control.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "ephemeral"
  ],
  "description": "Always `ephemeral`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].cache_control.ttl",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "5m",
  "minimum": null,
  "maximum": null,
  "enum": [
   "5m",
   "1h"
  ],
  "description": "Time-to-live of the cache entry.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Source of an `image` or `document` block. image: base64 | url | file. document: base64 (PDF) | text | content | url | file.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64",
   "url",
   "file",
   "text",
   "content"
  ],
  "description": "Source kind.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.media_type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image/jpeg",
   "image/png",
   "image/gif",
   "image/webp",
   "application/pdf",
   "text/plain"
  ],
  "description": "MIME type. image: image/jpeg|image/png|image/gif|image/webp. document base64: application/pdf. document text: text/plain.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.data",
  "location": "body",
  "type": "string (base64 or plain text)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Base64 payload (image/PDF) or plain text (document text source).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Public URL (image/PDF `url` source). Not accepted by /v1/messages/count_tokens.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.content",
  "location": "body",
  "type": "string|array<TextBlockParam|ImageBlockParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Custom content document (`content` source): string or array of text/image blocks; citations then use `content_block_location`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].transformations",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Image-only. Server-side transformations applied before the model sees the image.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].title",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Document title (shown to the model; used in citations as document_title).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].context",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Document context string passed to the model (not cited).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source (search_result)",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`search_result` block: source identifier/URL of the result.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].title (search_result)",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`search_result` block: title.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content (search_result)",
  "location": "body",
  "type": "array<TextBlockParam>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`search_result` block: text blocks of the result.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].thinking",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`thinking` block text, replayed exactly as returned.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].signature",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`thinking` block signature, replayed unmodified (modified blocks → 400).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`redacted_thinking` opaque encrypted payload, replayed unchanged.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`tool_use`/`server_tool_use` id (toolu_… / srvtoolu_…).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`tool_use` tool name; `server_tool_use` name ∈ web_search|web_fetch|code_execution|bash_code_execution|text_editor_code_execution|tool_search_tool_regex|tool_search_tool_bm25.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].input",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`tool_use` input object.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].caller",
  "location": "body",
  "type": "object",
  "required": false,
  "default": {
   "type": "direct"
  },
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Who invoked the tool: {type: direct} (default) or {type: code_execution_20250825|code_execution_20260120, tool_id}.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].toolset_name",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "For toolset member tools (computer/browser toolsets), the toolset family name.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].tool_use_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`tool_result`: id of the tool_use being answered. Every tool_use in the previous assistant turn needs a tool_result in the next user message (else 400).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content (tool_result)",
  "location": "body",
  "type": "string|array<text|image|search_result|document|tool_reference|browser_state>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`tool_result` content: string or array of blocks.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].is_error",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`tool_result`: mark the result as an error so the model treats it accordingly.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`container_upload`: Files API id to place in the code-execution container input directory.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content (server tool results)",
  "location": "body",
  "type": "object|array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Replayed server-tool result payloads (web_search_tool_result content = array<web_search_result> or error object; web_fetch_tool_result content = web_fetch block or error; code_execution/bash/text_editor/tool_search results = result or error object with `error_code`).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "system",
  "location": "body",
  "type": "string|array<TextBlockParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "System prompt: string or text blocks (each with optional cache_control and citations).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "system[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "Always `text`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "system[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "System text.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "system[].cache_control",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Cache control breakpoint at this block. `type` is always `ephemeral`; `ttl` is `5m` (default) or `1h` (1h TTL is GA; the old `extended-cache-ttl-2025-04-11` beta header is no longer required).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "system[].cache_control.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "ephemeral"
  ],
  "description": "Always `ephemeral`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "system[].cache_control.ttl",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "5m",
  "minimum": null,
  "maximum": null,
  "enum": [
   "5m",
   "1h"
  ],
  "description": "Time-to-live of the cache entry.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "stop_sequences",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Custom stop strings. When hit: stop_reason `stop_sequence`, `stop_sequence` = matched string; the matched text is excluded from `content` (live: '1 2 ' with stop '3').",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "stream",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Stream the response as SSE (text/event-stream).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Request metadata.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "metadata.user_id",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 512,
  "enum": [],
  "description": "Opaque end-user id (uuid/hash, no PII), ≤512 chars; used for abuse detection.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "service_tier",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "standard_only"
  ],
  "description": "`auto` (default: Priority Tier if the org has capacity, else standard) or `standard_only`. Echoed in usage.service_tier (live: 'standard' for both).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "cache_control (top-level).cache_control",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Cache control breakpoint at this block. `type` is always `ephemeral`; `ttl` is `5m` (default) or `1h` (1h TTL is GA; the old `extended-cache-ttl-2025-04-11` beta header is no longer required).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "cache_control (top-level).cache_control.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "ephemeral"
  ],
  "description": "Always `ephemeral`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "cache_control (top-level).cache_control.ttl",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "5m",
  "minimum": null,
  "maximum": null,
  "enum": [
   "5m",
   "1h"
  ],
  "description": "Time-to-live of the cache entry.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "cache_control (top-level)",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Top-level cache_control automatically marks the last cacheable block in the request (live: accepted).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "inference_geo",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Geographic inference region (e.g. `us`); defaults to the workspace `default_inference_geo`. Live on Haiku 4.5: 400 \"'claude-haiku-4-5-20251001' does not support inference_geo.\" Echoed in usage.inference_geo (live 'not_available').",
  "compatible_models": [
   "Claude 4.6+ (US-only inference priced 1.1x)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "container",
  "location": "body",
  "type": "string|object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Code-execution container to reuse: container id string or {id, skills[]}.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "container.id",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Existing container id.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "container.skills",
  "location": "body",
  "type": "array<SkillParams>|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Skills to load (≤20).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "container.skills[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "anthropic",
   "custom"
  ],
  "description": "anthropic (built-in) or custom.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "container.skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Skill id (1..64 chars).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "container.skills[].version",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Skill version or `latest`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Output configuration (effort, structured output format, task budget).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.effort",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "Effort level (models with `capabilities.effort.supported`; Haiku 4.5 reports unsupported).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.format",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Structured outputs (GA; the `structured-outputs-2025-11-13` beta header and the old top-level `output_format` are still accepted on the beta surface). Live: `output_format` without beta → 400 'Extra inputs are not permitted'.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.format.schema",
  "location": "body",
  "type": "object (JSON Schema)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Schema the response must follow.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_config.task_budget",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Beta. Token budget across contexts: {type: tokens, total ≥1024, remaining?}.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "task-budgets-2026-03-13",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Thinking configuration. Deep-dive owned by the thinking fragment.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking.display",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "summarized",
  "minimum": null,
  "maximum": null,
  "enum": [
   "summarized",
   "omitted",
   "updates"
  ],
  "description": "`summarized` (default) returns thinking text; `omitted` redacts text but keeps the signature; `updates` (beta thinking-display-updates-2026-08-18) streams only progress updates.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking.block_binding",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Beta. Controls replay of thinking blocks bound to a conversation prefix.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "thinking-binding-controls-2026-08-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking.block_binding.prefix_mismatch_behavior",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "error",
   "drop_block"
  ],
  "description": "`error` (400 on mismatch) or `drop_block` (drop the block and continue).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "thinking-binding-controls-2026-08-01",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools",
  "location": "body",
  "type": "array<ToolUnion>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Tool definitions (client tools with input_schema, and server/built-in tools by versioned `type`). Full catalogue owned by the tools fragment.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Omitted or `custom` for client tools; otherwise a versioned server/built-in tool type (bash_20250124, text_editor_20250124/20250429/20250728, web_search_20250305/20260209/20260318, web_fetch_20250910/20260209/20260309/20260318, code_execution_20250522/20250825/20260120/20260521, memory_20250818, tool_search_tool_regex_20251119, tool_search_tool_bm25_20251119, computer_toolset_20260801, browser_toolset_20260801, …).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Custom: ^[a-zA-Z0-9_-]{1,128}$. Fixed for Anthropic tools: bash, str_replace_based_edit_tool (str_replace_editor for 20250124), memory, computer, web_search, web_fetch, code_execution, tool_search_tool_regex, tool_search_tool_bm25, advisor. Absent on computer_toolset/browser_toolset/mcp_toolset entries.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Plaintext description; the most important lever for tool selection.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/define-tools",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].input_schema",
  "location": "body",
  "type": "object (JSON Schema 2020-12)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Client tools: schema of `input`. `type` must be `object`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].cache_control",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Cache control breakpoint at this block. `type` is always `ephemeral`; `ttl` is `5m` (default) or `1h` (1h TTL is GA; the old `extended-cache-ttl-2025-04-11` beta header is no longer required).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Exclude from initial system prompt; loaded on tool_reference from tool search. Max 10,000 deferred tools. At least one tool must be non-deferred (400).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].allowed_callers",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "direct",
   "code_execution_20250825",
   "code_execution_20260120",
   "code_execution_20260521"
  ],
  "description": "Who may call the tool.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].eager_input_streaming",
  "location": "body",
  "type": "boolean|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Fine-grained tool streaming for this tool (no server-side buffering/validation of `input_json_delta`). Replaces the legacy `fine-grained-tool-streaming-2025-05-14` beta header.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].input_examples",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Example inputs shown to the model.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "any",
   "tool",
   "none"
  ],
  "description": "auto | any | tool | none",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required when type=tool. Cannot name a tool whose allowed_callers omits direct (400) nor a toolset/member.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tool_choice.disable_parallel_tool_use",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "auto: at most one tool_use; any/tool: exactly one. Unsupported with programmatic tool calling. Changing it invalidates the messages cache.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/parallel-tool-use",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Beta. Server-side context edits applied before sampling. Response echoes `context_management.applied_edits[]` (live: []).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits",
  "location": "body",
  "type": "array<edit>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Ordered edits (minItems 0).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].keep",
  "location": "body",
  "type": "object|string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "clear_tool_uses: {type: tool_uses, value}; clear_thinking: {type: thinking_turns, value} | {type: all} | 'all'.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].clear_at_least",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "clear_tool_uses: {type: input_tokens, value} minimum to clear.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].clear_tool_inputs",
  "location": "body",
  "type": "boolean|array<string>|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "clear_tool_uses: also clear tool inputs (all or named tools).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].exclude_tools",
  "location": "body",
  "type": "array<string>|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "clear_tool_uses: tools whose uses are never cleared.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "context-management-2025-06-27",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "context_management.edits[].instructions",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "compact_20260112: custom summarization instructions.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "compact-2026-01-12",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "compaction",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Beta. Compact the whole conversation and return a single signed `compaction` block; nothing is sampled after it.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "compact-2026-09-04",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "compaction.instructions",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 16384,
  "enum": [],
  "description": "Replacement summarization prompt (≤16384 chars; blank = absent).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "compact-2026-09-04",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "mcp_servers",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Beta MCP connector: remote MCP servers Claude may call (≤20). Shape only; details owned by the tools fragment.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "mcp-client-2025-11-20 (or mcp-client-2025-04-04)",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "mcp_servers[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "url"
  ],
  "description": "Always `url`.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "mcp-client-2025-11-20",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "mcp_servers[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Server name (appears in mcp_tool_use.server_name).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "mcp-client-2025-11-20",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "mcp_servers[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Server URL.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "mcp-client-2025-11-20",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "mcp_servers[].authorization_token",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "OAuth bearer token forwarded to the server.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "mcp-client-2025-11-20",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "mcp_servers[].tool_configuration",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "{enabled?: boolean, allowed_tools?: string[]}.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "mcp-client-2025-11-20",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "speed",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "standard",
   "fast"
  ],
  "description": "Beta fast mode: `fast` = much faster output at premium pricing on supported models. Live on Haiku 4.5: 400 \"does not support the `speed` parameter\". Echoed as usage.speed.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "fast-mode-2026-02-01",
  "status": [
   "DOCUMENTED",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "diagnostics",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Beta. Prompt-cache divergence reporting; response gets `diagnostics` with cache-miss reasons.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "cache-diagnosis-2026-04-07",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "diagnostics.previous_message_id",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 256,
  "enum": [],
  "description": "Id of the previous message to compare the cache prefix against (≤256).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "cache-diagnosis-2026-04-07",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "fallbacks",
  "location": "body",
  "type": "array<object>|'default'",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Beta server-side fallback: ordered fallback models tried when the requested model refuses. Each entry: model, max_tokens?, output_config?, speed?, thinking?.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "server-side-fallback-2026-07-01 (or -2026-06-01)",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "fallback_credit_token",
  "location": "body",
  "type": "string|object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Beta. Token from a refused response's usage.fallback_credit; redeem on the client-side retry within 5 minutes so warm-prefix cache-creation tokens are billed at cache-read rate. Object form: {token, mode: strict|best_effort}.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "fallback-credit-2026-07-01 (or -2026-06-01)",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "output_format",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Legacy beta field for structured outputs (moved to output_config.format). Only accepted on the beta surface; without the header → 400 'output_format: Extra inputs are not permitted' (live).",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "structured-outputs-2025-11-13",
  "status": [
   "DOCUMENTED",
   "BETA",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "betas",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "SDK-only convenience parameter (client.beta.messages.*): the SDK turns it into the `anthropic-beta` header. It is NOT an API body field — live: 400 'betas: Extra inputs are not permitted'.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta-headers",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "anthropic-beta",
  "location": "header",
  "type": "string (comma-separated, repeatable)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Opt into beta features; multiple values comma-separated or repeated header. Unknown value → 400 'Unexpected value(s) … for the `anthropic-beta` header'.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta-headers",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Workspace to run in (wrkspc_…); required for multi-workspace keys.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "anthropic-user-profile-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Attribute the request to a user profile; requires a `user-profiles-*` beta header.",
  "compatible_models": [
   "all current models unless noted"
  ],
  "beta_header": "user-profiles-2026-09-04",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages",
  "_fragment": "generated/fragments/parameters/anthropic-messages.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of results to return per page. Ranges from `1` to `1000`. Defaults to `20`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/list",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination token for fetching a specific page of results. Pass the value from a previous response's `next_page` field to get the next page of results.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/list",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills",
  "parameter": "source",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter skills by source. If provided, only skills from the specified source will be returned: * `\"custom\"`: only return user-created skills * `\"anthropic\"`: only return Anthropic-created skills",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/list",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/list",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/skills",
  "parameter": "files",
  "location": "body",
  "type": "array of string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/create",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/skills",
  "parameter": "display_name",
  "location": "body",
  "type": "string or null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable, single-line label for the Skill. Maximum 255 characters. Always set: derived from the SKILL.md frontmatter `name` when omitted at creation. Not unique.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/create",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/skills",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/create",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/skills/{skill_id}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the skill. The format and length of IDs may change over time.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/delete",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/skills/{skill_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/delete",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the skill. The format and length of IDs may change over time.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the skill. The format and length of IDs may change over time.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions",
  "parameter": "limit",
  "location": "query",
  "type": "number",
  "required": false,
  "default": "20",
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Number of results to return per page. Ranges from `1` to `1000`. Defaults to `20`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optionally set to the `next_page` token from the previous response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/list",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/skills/{skill_id}/versions",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the skill. The format and length of IDs may change over time.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/create",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/skills/{skill_id}/versions",
  "parameter": "files",
  "location": "body",
  "type": "array of string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/create",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/skills/{skill_id}/versions",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/create",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/skills/{skill_id}/versions/{version}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the skill. The format and length of IDs may change over time.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/delete",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/skills/{skill_id}/versions/{version}",
  "parameter": "version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifies the skill version by its version ID. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., \"1759178010641129\").",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/delete",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "DELETE /v1/skills/{skill_id}/versions/{version}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/delete",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the skill. The format and length of IDs may change over time.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}",
  "parameter": "version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifies the skill version: a version ID, or the literal `latest` for the skill's most recent version. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., \"1759178010641129\").",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/retrieve",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}/content",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the skill. The format and length of IDs may change over time.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/download",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}/content",
  "parameter": "version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifies the skill version by its version ID. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., \"1759178010641129\").",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/download",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}/content",
  "parameter": "anthropic-workspace-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/skills/versions/download",
  "_fragment": "generated/fragments/parameters/anthropic-skills.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tool definitions (custom + Anthropic-provided). Union of custom tool objects and dated `type` objects. Tools are rendered into a system prompt whose token cost depends on model and tool_choice.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom",
   "bash_20250124",
   "text_editor_20250124",
   "text_editor_20250429",
   "text_editor_20250728",
   "memory_20250818",
   "computer_toolset_20260801",
   "browser_toolset_20260801",
   "computer_20251124",
   "computer_20250124",
   "web_search_20250305",
   "web_search_20260209",
   "web_search_20260318",
   "web_fetch_20250910",
   "web_fetch_20260209",
   "web_fetch_20260309",
   "web_fetch_20260318",
   "code_execution_20250522",
   "code_execution_20250825",
   "code_execution_20260120",
   "code_execution_20260521",
   "tool_search_tool_regex_20251119",
   "tool_search_tool_regex",
   "tool_search_tool_bm25_20251119",
   "tool_search_tool_bm25",
   "advisor_20260301",
   "mcp_toolset"
  ],
  "description": "Omitted or 'custom' for user-defined tools; otherwise an exact versioned type string (see tools fragment notes).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].input_schema",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON Schema (type object) for custom tools. Strict mode: structured-outputs subset.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/define-tools",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].input_examples",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Schema-validated example inputs (~20-200 tokens each). Not on server tools or toolsets. Invalid example -> 400.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/define-tools",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].cache_control",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{type: ephemeral, ttl?: 5m|1h}; put on the last tool to cache the whole tools prefix. Not with defer_loading:true (400).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-use-with-prompt-caching",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].allowed_callers",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "direct",
   "code_execution_20250825",
   "code_execution_20260120",
   "code_execution_20260521"
  ],
  "description": "Any of direct | code_execution_20250825 | code_execution_20260120 | code_execution_20260521. Default [direct]; web_search/web_fetch _20260209+ default [code_execution_20260120]. Toolsets accept only [direct].",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].eager_input_streaming",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Custom tools only. true = fine-grained tool streaming (no buffering/validation of input JSON). Replaces beta header fine-grained-tool-streaming-2025-05-14.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/fine-grained-tool-streaming",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].max_characters",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "text_editor_20250728+: truncation length for view.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].display_width_px",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "computer_20251124 / computer_20250124 (beta): display width; required. Rejected on computer_toolset_20260801.",
  "compatible_models": [],
  "beta_header": "computer-use-2025-11-24 | computer-use-2025-01-24",
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].display_height_px",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "computer_2025*: display height; required.",
  "compatible_models": [],
  "beta_header": "computer-use-2025-11-24 | computer-use-2025-01-24",
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].display_number",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "computer_2025*: X11 display number.",
  "compatible_models": [],
  "beta_header": "computer-use-2025-11-24 | computer-use-2025-01-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].enable_zoom",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "computer_20251124 only: enable the zoom action.",
  "compatible_models": [],
  "beta_header": "computer-use-2025-11-24",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].configs",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "computer_toolset_20260801 / browser_toolset_20260801: member name -> {enabled?, defer_loading?}. mcp_toolset: tool name -> {enabled?, defer_loading?}.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-reference",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].max_uses",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "web_search / web_fetch / advisor: per-request cap; exceeding yields a *_tool_result_error max_uses_exceeded.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].allowed_domains",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "web_search / web_fetch: bare domains (+path for search). Mutually exclusive with blocked_domains (400). Must be within org allowlist.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].blocked_domains",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "web_search / web_fetch: domains to exclude.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].user_location",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "web_search: {type: approximate, city?, region?, country? (2-letter, else 400), timezone?}.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].response_inclusion",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "full",
  "minimum": null,
  "maximum": null,
  "enum": [
   "full",
   "excluded"
  ],
  "description": "web_search_20260318 / web_fetch_20260318: drop result blocks consumed by completed code execution.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].citations",
  "location": "body",
  "type": "object",
  "required": false,
  "default": {
   "enabled": false
  },
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "web_fetch: {enabled: bool}; off by default (web search citations are always on).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].max_content_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "web_fetch: approximate cap on fetched text tokens (not PDFs). Must be > 0 (live 400).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].url_sources",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "web_fetch: {user_input: all|none, client_tool_results: all|none|only{tools}|except{tools}, server_tool_results: …}.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/api/messages/create",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].use_cache",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "web_fetch_20260309+: false bypasses the fetch cache.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "advisor_20260301: advisor model id (must form a valid executor/advisor pair).",
  "compatible_models": [],
  "beta_header": "advisor-tool-2026-03-01",
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/advisor-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].max_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1024,
  "maximum": null,
  "enum": null,
  "description": "advisor_20260301: cap on advisor output per call (min 1024).",
  "compatible_models": [],
  "beta_header": "advisor-tool-2026-03-01",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/advisor-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].caching",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "advisor_20260301: {type: ephemeral, ttl: 5m|1h} advisor-side caching switch.",
  "compatible_models": [],
  "beta_header": "advisor-tool-2026-03-01",
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/advisor-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].mcp_server_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "mcp_toolset: must match one mcp_servers[].name.",
  "compatible_models": [],
  "beta_header": "mcp-client-2025-11-20",
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/mcp-connector",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].default_config",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "mcp_toolset: {enabled? (default true), defer_loading? (default false)} applied to all tools of the server.",
  "compatible_models": [],
  "beta_header": "mcp-client-2025-11-20",
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/mcp-connector",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "container",
  "location": "body",
  "type": "string|object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Code execution container to reuse: id string, or {id?, skills?: [{type: anthropic|custom, skill_id, version}]} (max 20 skills). Required while a programmatic tool call is pending.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "container.skills[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{type: anthropic|custom, skill_id (1-64 chars), version ('latest' or version id)} — loads a Skill into the code execution container (Skills API CRUD is documented separately).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/skills-guide",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "mcp_servers",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Remote MCP servers (max 20): [{type: url, url (https), name, authorization_token?}]. Requires beta header.",
  "compatible_models": [],
  "beta_header": "mcp-client-2025-11-20",
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/mcp-connector",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "mcp_servers[].tool_configuration",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "DEPRECATED (mcp-client-2025-04-04): {enabled?, allowed_tools?[]}. Still accepted live with the old header.",
  "compatible_models": [],
  "beta_header": "mcp-client-2025-04-04",
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/mcp-connector",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[] (tool_result)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{type: tool_result, tool_use_id, content?: string|[text|image|document|search_result|tool_reference], is_error?: bool, toolset_name?: computer|browser (required echo for toolset members), cache_control?}. Must come first in the user message following the tool_use; only tool_result blocks when a server/programmatic call is pending.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/handle-tool-calls",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[] (container_upload)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{type: container_upload, file_id} — preload a Files API file into the code execution container.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[] (tool_use, replayed)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Assistant tool_use blocks (and server_tool_use / *_tool_result / mcp_tool_use / mcp_tool_result / tool_search_tool_result) must be replayed verbatim, including encrypted_content / encrypted_index.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages/count_tokens",
  "parameter": "tools",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Client tools and the advisor tool are counted; server tools (web_search, web_fetch, code_execution, tool_search) and mcp_servers -> 400 'Server tools are not supported in the count_tokens endpoint'.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/build-with-claude/token-counting",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "anthropic",
  "endpoint": "POST /v1/messages",
  "parameter": "anthropic-beta",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Header. Tool-related values: computer-use-2025-11-24, computer-use-2025-01-24, computer-use-2024-10-22 (legacy), advisor-tool-2026-03-01, mcp-client-2025-11-20, mcp-client-2025-04-04 (deprecated), fine-grained-tool-streaming-2025-05-14 (legacy no-op-ish), code-execution-2025-05-22 / code-execution-2025-08-25 (legacy opt-ins), web-fetch-2025-09-10 (legacy), advanced-tool-use-2025-11-20 (legacy for tool search/PTC), context-management-2025-06-27 (memory era).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://platform.claude.com/docs/en/api/beta-headers",
  "_fragment": "generated/fragments/parameters/anthropic-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:batchGenerateContent",
  "parameter": "batch.displayName",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-defined batch name (required).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/batch-api",
  "notes": "Live 2026-09-18: inline batch of 2 requests on gemini-3.5-flash-lite -> HTTP 400 FAILED_PRECONDITION: Precondition check failed.",
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:batchGenerateContent",
  "parameter": "batch.inputConfig.requests.requests[]",
  "location": "body",
  "type": "array<InlinedRequest>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline requests (total request < 20 MB). Each item: {request: GenerateContentRequest, metadata: {key: …}}. Output comes back inline (response.inlinedResponses).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/batch-api#inline-requests",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:batchGenerateContent",
  "parameter": "batch.inputConfig.requests.requests[].request",
  "location": "body",
  "type": "object GenerateContentRequest",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full request (contents, systemInstruction, tools, generationConfig incl. responseModalities for image generation, cachedContent…). The `model` field is taken from the URL.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api#GenerateContentRequest",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:batchGenerateContent",
  "parameter": "batch.inputConfig.requests.requests[].metadata",
  "location": "body",
  "type": "object (Struct)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free-form metadata echoed in InlinedResponse.metadata; convention {\"key\": \"request-1\"}.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api#InlinedRequest",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:batchGenerateContent",
  "parameter": "batch.inputConfig.fileName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files API name (files/…) of a JSONL input file (<= 2 GB), one {\"key\": …, \"request\": GenerateContentRequest} per line. Output = JSONL responsesFile. Mutually exclusive with requests.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/batch-api#input-file",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:batchGenerateContent",
  "parameter": "batch.priority",
  "location": "body",
  "type": "string (int64)",
  "required": false,
  "default": "0",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Higher value processed first; negative allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api",
  "notes": "Live: PATCH :updateGenerateContentBatch?updateMask=priority {priority:'1'} -> not run",
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:batchGenerateContent",
  "parameter": "batch.webhookConfig.uris[]",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-batch webhook URIs (override registered webhooks; events batch.succeeded / batch.failed).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:asyncBatchEmbedContent",
  "parameter": "batch.inputConfig.requests.requests[].request",
  "location": "body",
  "type": "object EmbedContentRequest",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{content:{parts:[{text}]}, embedContentConfig:{taskType, outputDimensionality, title}} (top-level taskType/title/outputDimensionality are deprecated).",
  "compatible_models": [
   "gemini-embedding-2",
   "gemini-embedding-2-preview",
   "gemini-embedding-001"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/batch-api#EmbedContentRequest",
  "notes": "Live: 1-request inline embedding batch on gemini-embedding-2 -> HTTP 400 FAILED_PRECONDITION: Precondition check failed.",
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:asyncBatchEmbedContent",
  "parameter": "batch.displayName",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Required user-defined batch name.",
  "compatible_models": [
   "gemini-embedding-001",
   "gemini-embedding-2",
   "gemini-embedding-2-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": 400,
   "request_note": "400 FAILED_PRECONDITION on free tier"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:asyncBatchEmbedContent",
  "parameter": "batch.inputConfig.fileName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSONL file of EmbedContentRequest lines (Files API).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/batch-api#batch-embedding-support",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/batches",
  "parameter": "pageSize",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard list page size.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/batch-api",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/batches",
  "parameter": "pageToken",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard list page token.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/batches",
  "parameter": "filter",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard list filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/batches",
  "parameter": "returnPartialSuccess",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return reachable operations and list unreachable ones; UNIMPLEMENTED unless documented.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/{name=batches/*}:updateGenerateContentBatch",
  "parameter": "updateMask",
  "location": "query",
  "type": "string (FieldMask)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Comma-separated fields to update (e.g. priority).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api#method:-batches.updategeneratecontentbatch",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/{name=batches/*}:updateEmbedContentBatch",
  "parameter": "updateMask",
  "location": "query",
  "type": "string (FieldMask)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Comma-separated fields to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/{name=batches/*}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "batches/{batchId} returned by create. Response is an Operation: metadata.state, done, response.inlinedResponses | response.responsesFile.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/batch-api",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "JSONL input line",
  "parameter": "key",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User key echoed in the output line.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/batch-api#input-file",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "JSONL input line",
  "parameter": "request",
  "location": "body",
  "type": "object GenerateContentRequest | EmbedContentRequest",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Request body per line (camelCase generationConfig or snake_case generation_config both appear in official samples).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/batch-api#input-file",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-batch.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/cachedContents",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Required, immutable, format `models/{id}` (else 400 \"Model name must be in the format 'models/{model_name}'\"). Caches are usable only with this exact model.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 400,
   "request_note": "i_cache_no_model 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/cachedContents",
  "parameter": "contents",
  "location": "body",
  "type": "array<Content>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Input-only, immutable content to cache (text, inlineData, fileData — e.g. a video File). Total tokens must reach the model minimum: live min_total_token_count=1024 on gemini-3.5-flash-lite (400 'Cached content is too small. total_token_count=6, min_total_token_count=1024'); gemini-3.5-flash: 400 'Cached content is too small. total_token_count=6, min_total_token_count=1024' (gemini-3.5-flash — the size check runs before the quota check; docs table says 4,096 for implicit caching). Docs (implicit caching table): 4,096 for 3.x Flash/Pro, 2,048 for 2.5.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 400,
   "request_note": "i_cache_below_min 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/cachedContents",
  "parameter": "systemInstruction",
  "location": "body",
  "type": "Content",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Input-only, immutable system instruction stored with the cache (text only). A request that uses the cache must not send its own systemInstruction (not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301' (ttl 120s, displayName, systemInstruction, 5301-token contents) — explicit caching needs a billing-enabled project"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/cachedContents",
  "parameter": "tools / toolConfig",
  "location": "body",
  "type": "array<Tool> / ToolConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Input-only, immutable tool declarations cached with the content (shape — tools domain).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/cachedContents",
  "parameter": "displayName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 128,
  "enum": [],
  "description": "Optional immutable label, ≤ 128 Unicode chars (PATCH of displayName: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301' (ttl 120s, displayName, systemInstruction, 5301-token contents) — explicit caching needs a billing-enabled project"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/cachedContents",
  "parameter": "ttl",
  "location": "body",
  "type": "string (Duration, e.g. '120s', '3600s')",
  "required": false,
  "default": "3600s",
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Input-only time-to-live; default 1 h when neither ttl nor expireTime is given; no documented min/max. Response always returns `expireTime` instead. Storage billed per token-hour ($1.00 / 1M tokens / h on 3.5 models).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "ttl 120s: 429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301' (ttl 120s, displayName, systemInstruction, 5301-token contents) — explicit caching needs a billing-enabled project"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/cachedContents",
  "parameter": "expireTime",
  "location": "body",
  "type": "string (RFC 3339 UTC timestamp)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Absolute expiry; mutually exclusive with ttl (union `expiration`). Always present on output.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "PATCH expireTime 2030-01-01T00:00:00Z: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/cachedContents/{id}",
  "parameter": "ttl | expireTime",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Only expiration fields are updatable. ttl '300s' → not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite); with ?updateMask=ttl → not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/cachedContents/{id}",
  "parameter": "updateMask",
  "location": "query",
  "type": "string (FieldMask)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Optional list of fields to update (e.g. `ttl`).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/cachedContents",
  "parameter": "pageSize",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 1000,
  "enum": [],
  "description": "Max items per page; server default when unset; max 1000 (coerced).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/cachedContents",
  "parameter": "pageToken",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "nextPageToken from a previous list call.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/cachedContents/{id}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`cachedContents/{id}` (ids are opaque, e.g. cachedContents/abc123…). After delete: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-cached-contents.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:countTokens",
  "parameter": "model",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Model whose tokenizer is used. Different models may count differently (gemini-3.5-flash-lite and gemini-3.5-flash both gave 11 for the fox sentence).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/tokens",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "g_count_text 11 / g_count_flash 11"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-count-tokens.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:countTokens",
  "parameter": "contents",
  "location": "body",
  "type": "array<Content>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Prompt turns to count (same Content/Part shapes as generateContent incl. inlineData, fileData, YouTube URLs). Ignored when generateContentRequest is set (verified: both sent → wrapper counted).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/tokens",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "g_count_text 200; g_count_both → 3 tokens = wrapper text"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-count-tokens.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:countTokens",
  "parameter": "generateContentRequest",
  "location": "body",
  "type": "GenerateContentRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Whole request to count — includes systemInstruction, tools, toolConfig, cachedContent, generationConfig (e.g. mediaResolution changes the count: PNG 1089 → 256 with LOW). Its `model` field is required in format models/{id} but the path model wins (mismatch accepted). Either contents or generateContentRequest must be present: empty body → 400 'CountTokens requires generate_content_request or contents to be set.'",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/tokens",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "g_count_wrapper_system_tools 51 tokens; g_count_wrapper_model_mismatch 200; g_count_empty 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-count-tokens.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:countTokens",
  "parameter": "systemInstruction (top level)",
  "location": "body",
  "type": "—",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "NOT accepted at top level (400 'Invalid JSON payload received. Unknown name \"systemInstruction\": Cannot find field.'); nest it inside generateContentRequest. SDK caveat: google-genai 2.24 and @google/genai 2.23 REFUSE system_instruction/tools in count_tokens for the Developer API ('system_instruction parameter is only supported in Gemini Enterprise Agent Platform mode, not in Gemini Developer API mode') — send the wrapper via raw REST.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/tokens",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 400,
   "request_note": "g_count_top_level_system 400 (expected: field lives inside generateContentRequest)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-count-tokens.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:countTokens",
  "parameter": "generateContentRequest.cachedContent",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Counting with a cache reports cachedContentTokenCount + cacheTokensDetails.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/tokens",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "i_cache_count_tokens: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-count-tokens.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:embedContent",
  "parameter": "model",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Embedding model: gemini-embedding-001 (text, 2,048 input tokens), gemini-embedding-2 / -2-preview (multimodal, 8,192 tokens). Generation models → 404 'not supported for embedContent'.",
  "compatible_models": [
   "gemini-embedding-001",
   "gemini-embedding-2",
   "gemini-embedding-2-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "h_embed_with_lite 404"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:embedContent",
  "parameter": "model (body)",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Optional repeat of `models/{id}` in the body (required in batch requests).",
  "compatible_models": [
   "gemini-embedding-001",
   "gemini-embedding-2",
   "gemini-embedding-2-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "accepted"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:embedContent",
  "parameter": "content",
  "location": "body",
  "type": "Content",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Content to embed. embedding-001: text parts only. embedding-2: text, inlineData/fileData image (≤ 6 PNG/JPEG), audio (≤ 180 s MP3/WAV), video (≤ 120 s MP4/MOV, 32 frames), PDF (1 file ≤ 6 pages, 258 tokens/page + text) — all parts of ONE content are aggregated into ONE vector; use several contents (batchEmbedContents) for separate vectors.",
  "compatible_models": [
   "gemini-embedding-001",
   "gemini-embedding-2",
   "gemini-embedding-2-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "h_embed_2_multipart_aggregate text+PNG → 1 vector, usage TEXT 3 + IMAGE 258"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:embedContent",
  "parameter": "taskType",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "TASK_TYPE_UNSPECIFIED",
   "RETRIEVAL_QUERY",
   "RETRIEVAL_DOCUMENT",
   "SEMANTIC_SIMILARITY",
   "CLASSIFICATION",
   "CLUSTERING",
   "QUESTION_ANSWERING",
   "FACT_VERIFICATION",
   "CODE_RETRIEVAL_QUERY"
  ],
  "description": "Task hint (top-level form deprecated in favour of embedContentConfig.taskType). Documented for gemini-embedding-001 only; docs say unsupported on gemini-embedding-2 (use `task: … | query: …` prompt prefixes) — live it was silently accepted (200) on embedding-2.",
  "compatible_models": [
   "gemini-embedding-001"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "h_embed_001 SEMANTIC_SIMILARITY 200; h_embed_2_tasktype 200 (no error despite docs)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:embedContent",
  "parameter": "title",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Document title, only with taskType RETRIEVAL_DOCUMENT (improves retrieval quality). Deprecated top-level form; also embedContentConfig.title.",
  "compatible_models": [
   "gemini-embedding-001"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "h_embed_001_title 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:embedContent",
  "parameter": "outputDimensionality",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 3072,
  "minimum": 128,
  "maximum": 3072,
  "enum": [],
  "description": "Matryoshka truncation of the 3072-d vector; supported 128–3072 (recommended 768, 1536, 3072). embedding-2 renormalizes truncated vectors; embedding-001 does not (normalize client-side). 4096 → 400 'Unable to submit request because the outputDimensionality value is not supported.' Deprecated top-level form; also embedContentConfig.outputDimensionality.",
  "compatible_models": [
   "gemini-embedding-001",
   "gemini-embedding-2",
   "gemini-embedding-2-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "64 → 64 floats on both models (below the documented 128 floor, accepted); default → 3072; 4096 → 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:embedContent",
  "parameter": "embedContentConfig",
  "location": "body",
  "type": "EmbedContentConfig {taskType, title, outputDimensionality, autoTruncate, documentOcr, audioTrackExtraction}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Preferred nested config (SDK EmbedContentConfig). autoTruncate silently truncates over-long input; documentOcr / audioTrackExtraction toggle PDF OCR and video audio-track processing (Gemini Developer API always OCRs PDFs; docs say documentOcr is Vertex-only).",
  "compatible_models": [
   "gemini-embedding-001",
   "gemini-embedding-2",
   "gemini-embedding-2-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "h_embed_2_config {outputDimensionality 64, autoTruncate true} → 200, 64 floats"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:batchEmbedContents",
  "parameter": "requests[]",
  "location": "body",
  "type": "array<EmbedContentRequest>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Batch of embed requests; each MUST include `model: models/{id}` matching the path (missing → 400 '* BatchEmbedContentsRequest.requests[0].model: model is not specified'). Response embeddings[] keeps order.",
  "compatible_models": [
   "gemini-embedding-001",
   "gemini-embedding-2",
   "gemini-embedding-2-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "h_batch_embed_001 → [64, 64]; h_batch_embed_no_model 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:asyncBatchEmbedContent",
  "parameter": "batch.inputConfig.requests.requests[].request / .metadata",
  "location": "body",
  "type": "InlinedEmbedContentRequest[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Inline requests (EmbedContentRequest + free-form metadata echoed in inlinedResponses) — or `batch.inputConfig.fileName` pointing to a JSONL File. Optional `batch.priority` (int64, higher first).",
  "compatible_models": [
   "gemini-embedding-001",
   "gemini-embedding-2",
   "gemini-embedding-2-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/api/embeddings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": 400,
   "request_note": "h_async_batch_embed 400 'Precondition check failed.'"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-embeddings.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/fileSearchStores",
  "parameter": "displayName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The human-readable display name for the `FileSearchStore`. The display name must be no more than 512 characters in length, including spaces. Example: \"Docs on Semantic Retriever\"",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/fileSearchStores",
  "parameter": "embeddingModel",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "default text embedding model",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The embedding model to use for the `FileSearchStore`. The model's resource name. This serves as an ID for the Model to use. Format: `models/{model}`. If not specified, the default embedding model will be used. Use models/gemini-embedding-2 for multimodal (image) File Search; default is text-only (gemini-embedding-001 per guide).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores",
  "parameter": "pageSize",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The maximum number of `FileSearchStores` to return (per page). The service may return fewer `FileSearchStores`. If unspecified, at most 10 `FileSearchStores` will be returned. The maximum size limit is 20 `FileSearchStores` per page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores",
  "parameter": "pageToken",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. A page token, received from a previous `ListFileSearchStores` call. Provide the `next_page_token` returned in the response as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListFileSearchStores` must match the call that provided the page token.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores/{name}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The name of the `FileSearchStore`. Example: `fileSearchStores/my-file-search-store-123`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/fileSearchStores/{name}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The resource name of the `FileSearchStore`. Example: `fileSearchStores/my-file-search-store-123`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/fileSearchStores/{name}",
  "parameter": "force",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. If set to true, any `Document`s and objects related to this `FileSearchStore` will also be deleted. If false (the default), a `FAILED_PRECONDITION` error will be returned if `FileSearchStore` contains any `Document`s.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "fileSearchStoreName",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. Immutable. The name of the `FileSearchStore` to upload the file into. Example: `fileSearchStores/my-file-search-store-123` Metadata-only URI: POST /v1beta/{fileSearchStoreName}:uploadToFileSearchStore; media upload URI: POST /upload/v1beta/...; resumable: /resumable/upload/v1beta/... (discovery mediaUpload).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "displayName",
  "location": "body(multipart metadata)",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Display name of the created document. Visible in citations.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "mimeType",
  "location": "body(multipart metadata)",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. MIME type of the data. If not provided, it will be inferred from the uploaded content.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "customMetadata",
  "location": "body(multipart metadata)",
  "type": "array<CustomMetadata>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Custom metadata to be associated with the data. Max 20 per Document.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "customMetadata[].key",
  "location": "body(multipart metadata)",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The key of the metadata to store.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents#CustomMetadata",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "customMetadata[].stringValue",
  "location": "body(multipart metadata)",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The string value of the metadata to store. One of stringValue | numericValue | stringListValue.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents#CustomMetadata",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "customMetadata[].numericValue",
  "location": "body(multipart metadata)",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The numeric value of the metadata to store.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents#CustomMetadata",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "customMetadata[].stringListValue.values",
  "location": "body(multipart metadata)",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The string values of the metadata to store. Enables INCLUDES/EXCLUDES filter operators.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents#StringList",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "chunkingConfig",
  "location": "body(multipart metadata)",
  "type": "object (ChunkingConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Config for telling the service how to chunk the data. If not provided, the service will use default parameters.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "chunkingConfig.whiteSpaceConfig",
  "location": "body(multipart metadata)",
  "type": "object (WhiteSpaceConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "White space chunking configuration. Only chunking algorithm exposed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "chunkingConfig.whiteSpaceConfig.maxTokensPerChunk",
  "location": "body(multipart metadata)",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 512,
  "enum": null,
  "description": "Maximum number of tokens per chunk. Tokens are defined as words for this chunking algorithm. Note: we are defining tokens as words split by whitespace as opposed to the output of a tokenizer. The context window of the latest gemini embedding model as of 2025-04-17 is currently 8192 tokens. We assume that the average word is 5 characters. Therefore, we set the upper limit to 2**9, which is 512 words, or 2560 tokens, assuming worst case a character per token. This is a conservative estimate meant to prevent context window overflow.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "chunkingConfig.whiteSpaceConfig.maxOverlapTokens",
  "location": "body(multipart metadata)",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of overlapping tokens between two adjacent chunks.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "<file bytes>",
  "location": "file",
  "type": "binary (any MIME, max 100 MB)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Media payload. Simple/multipart protocol: multipart/related body (JSON metadata part + media part). Resumable protocol: first POST with headers X-Goog-Upload-Protocol: resumable, X-Goog-Upload-Command: start, X-Goog-Upload-Header-Content-Length, X-Goog-Upload-Header-Content-Type and the JSON metadata body; then POST the bytes to the returned X-Goog-Upload-URL with X-Goog-Upload-Offset: 0 and X-Goog-Upload-Command: upload, finalize. Discovery mediaUpload: accept */*, maxSize 104857600.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/file-search",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "X-Goog-Upload-Protocol",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "'resumable' (or 'multipart') — selects the upload protocol on the /upload/ URI.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/file-search",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "X-Goog-Upload-Command",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "'start' on the initiating request; 'upload, finalize' on the byte-transfer request (resumable protocol).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/file-search",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "X-Goog-Upload-Header-Content-Length",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Total byte length of the file (initiating request).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/file-search",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "X-Goog-Upload-Header-Content-Type",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the file (initiating request).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/file-search",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/fileSearchStores/{name}:uploadToFileSearchStore",
  "parameter": "X-Goog-Upload-Offset",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Byte offset of the chunk being sent (0 for a single-shot upload).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/file-search",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/fileSearchStores/{name}:importFile",
  "parameter": "fileSearchStoreName",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. Immutable. The name of the `FileSearchStore` to import the file into. Example: `fileSearchStores/my-file-search-store-123`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/fileSearchStores/{name}:importFile",
  "parameter": "fileName",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The name of the `File` to import. Example: `files/abc-123` A Files API resource (files/*) uploaded earlier; File objects expire after 48 h but the imported chunks persist.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/fileSearchStores/{name}:importFile",
  "parameter": "customMetadata",
  "location": "body",
  "type": "array<CustomMetadata>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Custom metadata to be associated with the file. Same shape as uploadToFileSearchStore (key + stringValue|numericValue|stringListValue).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/fileSearchStores/{name}:importFile",
  "parameter": "chunkingConfig",
  "location": "body",
  "type": "object (ChunkingConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Config for telling the service how to chunk the file. If not provided, the service will use default parameters. whiteSpaceConfig.maxTokensPerChunk / maxOverlapTokens.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores/{name}/documents",
  "parameter": "parent",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The name of the `FileSearchStore` containing `Document`s. Example: `fileSearchStores/my-file-search-store-123`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores/{name}/documents",
  "parameter": "pageSize",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The maximum number of `Document`s to return (per page). The service may return fewer `Document`s. If unspecified, at most 10 `Document`s will be returned. The maximum size limit is 20 `Document`s per page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores/{name}/documents",
  "parameter": "pageToken",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. A page token, received from a previous `ListDocuments` call. Provide the `next_page_token` returned in the response as an argument to the next request to retrieve the next page. When paginating, all other parameters provided to `ListDocuments` must match the call that provided the page token.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores/{name}/documents/{document}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The name of the `Document` to retrieve. Example: `fileSearchStores/my-file-search-store-123/documents/the-doc-abc`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/fileSearchStores/{name}/documents/{document}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The resource name of the `Document` to delete. Example: `fileSearchStores/my-file-search-store-123/documents/the-doc-abc`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/fileSearchStores/{name}/documents/{document}",
  "parameter": "force",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. If set to true, any `Chunk`s and objects related to this `Document` will also be deleted. If false (the default), a `FAILED_PRECONDITION` error will be returned if `Document` contains any `Chunk`s.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/documents",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores/{name}/operations/{operation}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the operation resource. Operation returned by importFile.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores/{name}/upload/operations/{operation}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the operation resource. Operation returned by uploadToFileSearchStore (name pattern fileSearchStores/*/upload/operations/*).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/file-search/file-search-stores",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/fileSearchStores/{name}/media/{blob}",
  "parameter": "mediaId",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Media blob resource name from groundingChunks[].retrievedContext.mediaId (format fileSearchStores/{store}/media/{blobId}); downloads the cited image chunk. SDK: client.file_search_stores.download_media(media_id=...). Not in the v1beta discovery method list on 2026-09-18 (guide shows a /v1/ URL).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/file-search",
  "_fragment": "generated/fragments/parameters/gemini-file-search.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].fileSearch.fileSearchStoreNames",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The names of the file_search_stores to retrieve from. Example: `fileSearchStores/my-file-search-store-123`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#FileSearch",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].fileSearch.metadataFilter",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Metadata filter to apply to the semantic retrieval documents and chunks. AIP-160 list-filter syntax over customMetadata, e.g. author = \"Robert Graves\", year > 1930.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#FileSearch",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].fileSearch.topK",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The number of semantic retrieval chunks to retrieve. Only in REST reference/discovery (not in the guide).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FileSearch",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/files",
  "parameter": "X-Goog-Upload-Protocol",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "resumable"
  ],
  "description": "Upload protocol selector for the first request: `resumable` (start a session) — the only value used by the docs; simple uploads use the `uploadType` query instead.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "j_upload_start 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/files",
  "parameter": "X-Goog-Upload-Command",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "start",
   "upload",
   "finalize",
   "upload, finalize",
   "query",
   "cancel"
  ],
  "description": "`start` on the metadata request; then `upload, finalize` (single shot), or `upload` per chunk followed by `finalize`; `query` and `cancel` are the resumable protocol's control commands (on X-Goog-Upload-Control-URL).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "start + 'upload, finalize' verified"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/files",
  "parameter": "X-Goog-Upload-Header-Content-Length",
  "location": "header",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Total byte size of the media to be uploaded (start request).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "200 with value 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/files",
  "parameter": "X-Goog-Upload-Header-Content-Type",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "MIME type of the media (start request); becomes File.mimeType.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "text/plain → File.mimeType text/plain"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/files",
  "parameter": "X-Goog-Upload-Offset",
  "location": "header",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Byte offset of the chunk being sent (0 for a single-shot upload). Chunks must respect X-Goog-Upload-Chunk-Granularity (8 MiB observed).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "0 verified"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/files",
  "parameter": "X-Goog-Upload-URL (response)",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Session URL returned by `start` (absolute URL on generativelanguage.googleapis.com with upload_id); POST the bytes there. Also returned: X-Goog-Upload-Control-URL, X-Goog-Upload-Status (active → final), X-Goog-Upload-Chunk-Granularity: 8388608.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "present on j_upload_start; finalize response carried X-Goog-Upload-Status: final"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/files",
  "parameter": "uploadType",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "multipart",
   "media"
  ],
  "description": "Simple-upload selector: `multipart` (multipart/related body: JSON metadata part + media part) or `media` (raw bytes, Content-Type = media type). Legacy Google upload protocol, verified working.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "j_upload_multipart_pdf 200 (application/pdf, state ACTIVE); j_upload_simple_raw 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/files",
  "parameter": "file.displayName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 512,
  "enum": [],
  "description": "Human-readable name ≤ 512 chars (JSON metadata in the start request / multipart metadata part).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "'atlas-probe.txt' echoed"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /upload/v1beta/files",
  "parameter": "file.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Optional custom id `files/<id>`: ≤ 40 lowercase alphanumerics or dashes, no leading/trailing dash; server generates one when omitted (observed 12-char ids like files/w7x6n2hlpxrq).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/files",
  "parameter": "pageSize",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Max Files per page (server default when omitted).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "pageSize=3 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/files",
  "parameter": "pageToken",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "nextPageToken from a previous call.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/files/{id}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "`files/{id}`. Unknown/deleted → 403 PERMISSION_DENIED (not 404).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    403
   ],
   "request_note": "j_files_get 200; j_files_get_missing 403"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/files:register",
  "parameter": "uris[]",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Google Cloud Storage URIs `gs://bucket/object` to register (not copied). Any failure fails the whole call. Registered files have `source: REGISTERED` and no expirationTime in the response (docs: valid up to 30 days).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/files",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "public scones.jpg registered → 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/generatedFiles",
  "parameter": "pageSize / pageToken",
  "location": "query",
  "type": "integer / string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Pagination for generated files.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "pageSize=3 → 200 {}"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-files.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "model",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Model id (`gemini-3.5-flash-lite`, `gemini-3.8-flash`, …) or `models/{id}` prefix implied by the route; also `tunedModels/{id}` and `dynamic/{id}` resources. Unknown id → 404 NOT_FOUND 'models/<id> is not found for API version v1beta, or is not supported for generateContent. Call ModelService.ListModels …'. Embedding models → same 404.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    404
   ],
   "request_note": "a_minimal 200; gemini-99-ultra and gemini-embedding-001 → 404"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "alt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json",
   "sse",
   "media",
   "proto"
  ],
  "description": "Response format. `sse` turns even the non-streaming method into a one-event `text/event-stream`; `json` (default); `media`/`proto` from the discovery global params.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "a_alt_sse_nonstream → 200 text/event-stream with a single `data:` line"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "key",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "API key as a query parameter (discovery global parameter). Works but the key then appears in URLs/logs — this atlas never uses it; send `x-goog-api-key` instead.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "fields|prettyPrint|quotaUser|$.xgafv|callback",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Standard Google API system parameters (partial response FieldMask, pretty printing, quota attribution, error format 1|2, JSONP).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "x-goog-api-key",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "API key header (recommended auth). Missing/invalid → 400/403 with status INVALID_ARGUMENT/PERMISSION_DENIED.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/api-key",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "all 190 probe calls"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents",
  "location": "body",
  "type": "array<Content>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Required conversation: ordered `Content` turns. Single-turn = one user Content. Multi-turn = alternating user/model turns; the last turn must be a user turn ('Requests ending with a model turn are not supported.'). A bare Content object instead of an array is accepted (proto JSON leniency, verified). Missing → 400 '* GenerateContentRequest.contents: contents is not specified'.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "a_minimal, a_multiturn ('Atlas' recalled), a_contents_single_object 200; l_missing_contents 400; role model last → 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].role",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "model"
  ],
  "description": "Producer of the turn: `user` or `model`. Optional for single-turn (omitted → treated as user, verified). `assistant`/`system` are not valid roles (request with a final `assistant` turn was rejected as a model turn).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "a_no_role 200; a_role_assistant_invalid 400 'Requests ending with a model turn are not supported.'"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts",
  "location": "body",
  "type": "array<Part>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Ordered parts of one turn; each Part carries exactly one data field (text | inlineData | fileData | functionCall | functionResponse | executableCode | codeExecutionResult | toolCall | toolResponse) plus optional metadata (thought, thoughtSignature, videoMetadata, mediaResolution, mediaProcessing, partMetadata). Empty parts array → see l_empty_parts.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "l_empty_parts: 400 INVALID_ARGUMENT 'Request has empty input.'"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text to speak, optionally prefixed with natural-language direction (\"Say cheerfully: …\", audio profile / scene / director's notes) and inline audio tags like [whispers], [laughs], [very fast]. Context window 32k tokens; input token limit 8,192.",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview",
   "gemini-2.5-flash-preview-tts",
   "gemini-2.5-pro-preview-tts"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/speech-generation#prompting-guide",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].inlineData.mimeType",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "IANA MIME type of the inline bytes. Documented families: image/png, image/jpeg, image/webp, image/heic, image/heif, image/gif, image/avif; audio/*; video/*; text/plain, text/html, text/css, text/javascript, text/x-typescript, text/csv, text/markdown, text/x-python, text/xml, text/rtf; application/pdf, application/json, application/x-javascript, application/x-typescript, application/x-python-code, application/x-ipynb+json, application/rtf. Unsupported type → 400 (see k_inline_bad_mime).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/file-input-methods",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "image/png (1089 IMAGE tokens), application/pdf (520 IMAGE tokens/page, answer read correctly) 200; image/bmp: 200 — PNG bytes declared as image/bmp were accepted (1089 IMAGE tokens): the declared MIME is not validated against the bytes; text/plain inline: 200 → 'FALCON' (inline text/plain blob read as text; counted as TEXT 17 tokens)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].inlineData.data",
  "location": "body",
  "type": "string (base64)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Raw media bytes, base64-encoded. Total inline request payload limit: 20 MB (image/audio/video guides) — larger media must go through the Files API.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/image-understanding",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "k_inline_png 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].inlineData.displayName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Name the model can use to refer to the blob (e.g. from function responses with verbalization_mode REFERENCE_ONLY).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].fileData.fileUri",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "URI of a File (`https://generativelanguage.googleapis.com/v1beta/files/<id>` from the Files API, or a registered GCS file), a public YouTube URL (`https://www.youtube.com/watch?v=…`, preview, ≤ 10 videos/request on 2.5+, free tier ≤ 8 h/day) or a publicly accessible HTTPS/pre-signed media URL (≤ 100 MB, fetched per request). Deleted/unknown file → 403 PERMISSION_DENIED.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/file-input-methods",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    403
   ],
   "request_note": "j_generate_with_file (text/plain → 'PELICAN'), j_generate_with_pdf ('ATLAS') 200; YouTube URL counted by countTokens (VIDEO 10650 + AUDIO 4777 tokens); deleted file → 403"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].fileData.mimeType",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Optional MIME type of the referenced file; omitted → taken from the File resource (verified for text/plain).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "j_generate_with_file_no_mime 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].fileData.displayName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Reference name for the file (see inlineData.displayName).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionCall",
  "location": "body",
  "type": "object {name, args, id}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Model-emitted tool call (shape only here — see the tools domain). When echoing history back, keep the part's `thoughtSignature`.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/function-calling",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionResponse",
  "location": "body",
  "type": "object {name, response, id, parts[], scheduling, willContinue}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Client tool result (shape only — tools domain). `response` is a free-form JSON object; multimedia via `parts[].inlineData` referenced with `$ref` = displayName.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/function-calling",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].executableCode / codeExecutionResult",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Code-execution tool parts (shape only — tools domain): {language: PYTHON, code, id} / {outcome: OUTCOME_OK|OUTCOME_FAILED|OUTCOME_DEADLINE_EXCEEDED, output, id}.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/code-execution",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolCall / toolResponse",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Server-side built-in tool invocations (toolType GOOGLE_SEARCH_WEB|GOOGLE_SEARCH_IMAGE|URL_CONTEXT|GOOGLE_MAPS|FILE_SEARCH) surfaced when `toolConfig.includeServerSideToolInvocations` is true; the client echoes them back verbatim (shape only — tools domain).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED",
   "DOCUMENTED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].thought",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Marks a thought-summary part (output; set only when `thinkingConfig.includeThoughts` is true and the model produced a summary). Sending thought parts back in history is allowed (SDKs do it).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "e_flash_thoughts_budget: first part {text: '**My Calculation…', thought: true}; e_lite_budget_minus1: thought part only + finishReason MAX_TOKENS"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].thoughtSignature",
  "location": "body",
  "type": "string (base64 bytes)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Opaque encrypted reasoning state. Gemini 3 models attach one to the last part of every response (text parts included, even without thinking) and to the first functionCall of each step. Return it unchanged with the part: mandatory for function calls in the current turn on Gemini 3 (400 'Function call <name> in the <n>. content block is missing a thought_signature'), recommended for text. A tampered value → 400 'Corrupted thought signature.'; the documented dummy values `skip_thought_signature_validator` / `context_engineering_is_the_way_to_go` bypass validation (verified).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/thought-signatures",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "a_sig_roundtrip 200; a_sig_bogus 400 'Corrupted thought signature.'; a_sig_skip_validator 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].videoMetadata.startOffset / endOffset",
  "location": "body",
  "type": "string (Duration, e.g. '40s')",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Clip the video (inlineData or fileData incl. YouTube) to a window; static processing only. Discovery marks VideoMetadata deprecated in favour of `GenerateContentRequest.processing_options` (not yet exposed).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/video-understanding",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "g_count_youtube_clip 0s–10s: VIDEO 710 + AUDIO 320 tokens vs 10650 + 4777 for the full video"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].videoMetadata.fps",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1.0,
  "minimum": 0,
  "maximum": 24,
  "enum": [],
  "description": "Frame sampling rate sent to the model; default 1.0; range (0.0, 24.0]. Token usage scales with fps.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/video-understanding",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "fps 1 accepted in g_count_youtube_clip"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].mediaResolution.level",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "MEDIA_RESOLUTION_UNSPECIFIED",
   "MEDIA_RESOLUTION_LOW",
   "MEDIA_RESOLUTION_MEDIUM",
   "MEDIA_RESOLUTION_HIGH",
   "MEDIA_RESOLUTION_ULTRA_HIGH"
  ],
  "description": "Per-part media resolution (Gemini 3 only) overriding `generationConfig.mediaResolution`; adds ULTRA_HIGH (2240 image tokens, needed for computer use). Observed on gemini-3.5-flash-lite for a 1×1 PNG: default/HIGH 1089, MEDIUM 529 IMAGE tokens, LOW 256 IMAGE tokens (per-part mediaResolution.level MEDIA_RESOLUTION_LOW), ULTRA_HIGH 2209 IMAGE tokens.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/media-resolution",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "g_count_png_part_res_high → 1089 IMAGE tokens"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].mediaProcessing",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "MEDIA_PROCESSING_UNSPECIFIED",
   "STATIC",
   "AGENTIC"
  ],
  "description": "Video-only: STATIC = fixed 1 fps frame extraction (all frames in context); AGENTIC = model-driven navigation loading only needed frames/transcript/audio (up to 88 % fewer tokens; reported in usageMetadata.toolUsePromptTokenCount + thoughtsTokenCount). Supported for agentic: gemini-3.8/3.7/3.6-flash, gemini-3.5-flash-lite.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/video-understanding",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].partMetadata",
  "location": "body",
  "type": "object (Struct)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Free-form client metadata attached to a Part (agent bookkeeping, e.g. source file name). Discovery only.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].audioTranscription",
  "location": "body",
  "type": "object {text, speakerLabel, words[]}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Output-only transcription attached to audio parts by transcription models (`generationConfig.audioTranscriptionConfig`) — media domain.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "systemInstruction",
  "location": "body",
  "type": "Content",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Developer instructions applied to the whole request (text parts only). `role` is ignored (`system`, omitted both work). snake_case `system_instruction` also accepted. Counted in promptTokenCount. Cannot be combined with a cache that already has one (see gemini-cached-contents.json).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/text-generation",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "c_system_gencfg ('OK' to 2+2 question), c_system_role_system, c_system_instruction_snake 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools",
  "location": "body",
  "type": "array<Tool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. List of Tool objects the model may use. Each Tool object carries one or more of: functionDeclarations[], googleSearch, googleSearchRetrieval (legacy), googleMaps, urlContext, codeExecution, computerUse, fileSearch, mcpServers[]. Several tools may be combined in one request (see tool-combination rules).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#request-body",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig",
  "location": "body",
  "type": "object {functionCallingConfig:{mode: AUTO|ANY|NONE|VALIDATED, allowedFunctionNames[]}, retrievalConfig:{latLng, languageCode}, includeServerSideToolInvocations}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Tool behaviour (shape only — tools domain).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/function-calling",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "safetySettings",
  "location": "body",
  "type": "array<SafetySetting>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Per-category block thresholds; at most one entry per category (a duplicate category was silently accepted live). Default when absent: filters OFF for Gemini 2.5/3 (only the built-in child-safety protections apply). Adding any setting makes the response carry `candidates[].safetyRatings` for the 4 adjustable categories (verified: 4 NEGLIGIBLE ratings); with BLOCK_NONE/OFF no ratings are returned.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/safety-settings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "f_safety_block_low → 4 safetyRatings; f_safety_block_none/f_safety_off → no ratings; f_safety_duplicate 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "safetySettings[].category",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "HARM_CATEGORY_HARASSMENT",
   "HARM_CATEGORY_HATE_SPEECH",
   "HARM_CATEGORY_SEXUALLY_EXPLICIT",
   "HARM_CATEGORY_DANGEROUS_CONTENT",
   "HARM_CATEGORY_CIVIC_INTEGRITY",
   "HARM_CATEGORY_JAILBREAK"
  ],
  "description": "Harm category. Accepted live: HARM_CATEGORY_HARASSMENT, HATE_SPEECH, SEXUALLY_EXPLICIT, DANGEROUS_CONTENT, CIVIC_INTEGRITY (deprecated → use generationConfig.enableEnhancedCivicAnswers; still accepted, ratings for the 4 standard categories only), JAILBREAK (accepted). PaLM categories (DEROGATORY, TOXICITY, VIOLENCE, SEXUAL, MEDICAL, DANGEROUS) → 400 '* GenerateContentRequest.safety_settings[0]: element predicate failed: $.category in (…)'. Unknown → 400 'Invalid value at safety_settings[0].category'.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/safety-settings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "f_safety_civic, f_safety_jailbreak 200; f_safety_palm_category 400; f_safety_bogus 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "safetySettings[].threshold",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
   "BLOCK_LOW_AND_ABOVE",
   "BLOCK_MEDIUM_AND_ABOVE",
   "BLOCK_ONLY_HIGH",
   "BLOCK_NONE",
   "OFF"
  ],
  "description": "Block probability threshold: OFF (filter off) · BLOCK_NONE (always show) · BLOCK_ONLY_HIGH · BLOCK_MEDIUM_AND_ABOVE · BLOCK_LOW_AND_ABOVE · HARM_BLOCK_THRESHOLD_UNSPECIFIED (default). Blocking is by probability, not severity.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/safety-settings",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "BLOCK_LOW_AND_ABOVE, BLOCK_NONE, OFF all 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "cachedContent",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Name of an explicit cache (`cachedContents/{id}`) used as prompt prefix; the cache's model must equal the request model, and the request must not repeat systemInstruction/tools already in the cache. usageMetadata.cachedContentTokenCount reports the cached part (promptTokenCount still includes it).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/caching",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "restricted",
   "http_status": null,
   "request_note": "i_cache_generate: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite) | wrong model: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite) | + systemInstruction: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite) | deleted cache: not executed — cache creation blocked on this free-tier key (429 RESOURCE_EXHAUSTED 'TotalCachedContentStorageTokensPerModelFreeTier limit exceeded for model gemini-3.5-flash: limit=0, requested=5301'; same for gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "serviceTier",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "standard",
  "minimum": null,
  "maximum": null,
  "enum": [
   "unspecified",
   "standard",
   "flex",
   "priority"
  ],
  "description": "Processing tier: standard (default; echoed as usageMetadata.serviceTier 'standard'), flex (cheaper, best-effort latency — flex-inference guide), priority (2× price, priority-inference guide). Invalid value → 400 'Invalid value at service_tier (…ServiceTier), \"turbo\"'.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/flex-inference",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "c_service_tier_standard: 200, usageMetadata.serviceTier 'standard' | flex: 200 in 0.7 s, usageMetadata.serviceTier 'flex' echoed (flex accepted on the free tier) | bogus → 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "labels",
  "location": "body",
  "type": "map<string,string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "User metadata (Cloud label rules: keys start with a letter, ≤ 63 chars, lowercase/digits/_/-). Documented use: `safety_identifier` for aggregators (e.g. {\"safety_identifier\": \"user_session_123\"}).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "c_labels_store: 200 with labels {env: atlas-probe} and store false (no echo in the response)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "store",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Per-request override of the project logging (prompt-logging) configuration.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "sent together with labels: 200 with labels {env: atlas-probe} and store false (no echo in the response)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig",
  "location": "body",
  "type": "GenerationConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Sampling/output configuration object. Unknown keys → 400 'Invalid JSON payload received. Unknown name \"<k>\" at generation_config: Cannot find field.' (fieldViolations detail).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "c_unknown_field 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1.0,
  "minimum": 0.0,
  "maximum": 2.0,
  "enum": [],
  "description": "Randomness, range [0.0, 2.0] (verified message: 'temperature must be in the range [0.0, 2.0]'). Model defaults from models.get: 1.0 for gemini-3.5-flash-lite (maxTemperature 2). Gemini 3.x: Google strongly recommends leaving it at 1.0 (lower values can loop/degrade).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/gemini-3",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "c_system_gencfg 0.2 → 200; 2.5 → 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.topP",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 0.95,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Nucleus sampling cumulative probability. Default per model (0.95 for gemini-3.5-flash-lite). Not recommended to change on Gemini 3.x.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "0.9 accepted"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.topK",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 64,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Top-k sampling; default per model (64 for gemini-3.5-flash-lite; models with no topK in models.get reject the field). Not recommended to change on Gemini 3.x.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "40 accepted"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.candidateCount",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Number of candidates. Gemini 3.x models do not support values > 1 (docs: 400). Default 1.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/gemini-3",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 400,
   "request_note": "c_candidate_count_2 on gemini-3.5-flash-lite: 400 INVALID_ARGUMENT 'Multiple candidates is not enabled for this model' (gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.maxOutputTokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Hard cap on generated tokens INCLUDING thinking tokens; hitting it → finishReason MAX_TOKENS and possibly empty text (verified: thinkingBudget -1 with maxOutputTokens 64 returned only a thought part, thoughtsTokenCount 60, no candidatesTokenCount). Default = model outputTokenLimit (65536 for 3.x Flash/Pro).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "c_max_tokens_hit: 8 → MAX_TOKENS after 4 tokens; e_lite_budget_minus1 truncated thoughts"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.stopSequences",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 5,
  "enum": [],
  "description": "Up to 5 stop strings (6 → 400 '* GenerateContentRequest.generation_config.stop_sequences: the number of stop_sequences must not exceed 5.'); the sequence is not included in the output.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "c_stop_sequences_6 400; 1 sequence 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.presencePenalty",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Binary penalty on tokens already present in the response (positive = more vocabulary).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "failure",
   "http_status": 400,
   "request_note": "c_penalties: 400 INVALID_ARGUMENT 'Penalty is not enabled for this model' (presencePenalty 0.5 + frequencyPenalty 0.5 on gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.frequencyPenalty",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Penalty proportional to the number of prior uses of a token; large negative values make the model repeat until maxOutputTokens.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "failure",
   "http_status": 400,
   "request_note": "c_penalties: 400 INVALID_ARGUMENT 'Penalty is not enabled for this model' (presencePenalty 0.5 + frequencyPenalty 0.5 on gemini-3.5-flash-lite)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.seed",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Decoding seed (random when unset). Determinism is best-effort.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "seed 42 accepted; repeat test seed 7: two calls with seed 7 / temperature 1.0 both returned 'Capybara' (deterministic in this sample)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.responseLogprobs",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Return log-probabilities in candidates[].logprobsResult (+ avgLogprobs).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "failure",
   "http_status": 400,
   "request_note": "c_logprobs: 400 INVALID_ARGUMENT 'Logprobs is not enabled for this model' (gemini-3.5-flash-lite; responseLogprobs true + logprobs 2)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.logprobs",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 20,
  "enum": [],
  "description": "Number of top logprobs per decoding step in logprobsResult.topCandidates (0–20); only valid with responseLogprobs=true.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "failure",
   "http_status": 400,
   "request_note": "c_logprobs: 400 INVALID_ARGUMENT 'Logprobs is not enabled for this model' (gemini-3.5-flash-lite; responseLogprobs true + logprobs 2)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.responseMimeType",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "text/plain",
  "minimum": null,
  "maximum": null,
  "enum": [
   "text/plain",
   "application/json",
   "application/xml",
   "application/yaml",
   "text/x.enum"
  ],
  "description": "Output MIME type. Allowed (verbatim 400 text): `text/plain` (default), `application/json`, `application/xml`, `application/yaml`, `text/x.enum`. `text/x.enum` returns one enum string from responseSchema. Discovery: deprecated in favour of responseFormat.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/structured-output",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "d_bad_mime text/html → 400 'allowed mimetypes are …'; application/json: 200 → '{\"word\": \"OK\", \"ok\": true}' — propertyOrdering [word, ok] honoured | text/x.enum: 200 → 'OK' (1 candidate token) with responseMimeType text/x.enum + responseSchema {type STRING, enum [OK, NOT_OK]} | application/xml: 200 → '<response>\\n  <ok>true</ok>' with responseMimeType application/xml"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.responseSchema",
  "location": "body",
  "type": "Schema (OpenAPI 3.0 subset)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Legacy typed schema: {type: STRING|NUMBER|INTEGER|BOOLEAN|ARRAY|OBJECT|NULL, format, description, nullable, enum[], items, properties, required[], propertyOrdering[], minItems, maxItems, minimum, maximum, minLength, maxLength, pattern, anyOf[], title, default, example, minProperties, maxProperties}. Requires a compatible responseMimeType. Non-Schema keywords (e.g. additionalProperties) → 400 'Unknown name \"additionalProperties\" at generation_config.response_schema'. Deprecated in discovery (use responseFormat).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/structured-output",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "d_schema_unknown_keyword 400; d_json_response_schema: 200 → '{\"word\": \"OK\", \"ok\": true}' — propertyOrdering [word, ok] honoured | without mime: 200 but responseSchema silently IGNORED without responseMimeType (plain prose 'Here is…') | both schemas: 200 but BOTH schemas ignored and plain prose returned ('Here is the') even with responseMimeType application/json — no 400 (docs say responseSchema must be omitted)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.responseJsonSchema",
  "location": "body",
  "type": "object (JSON Schema)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Standard JSON Schema alternative to responseSchema (mutually exclusive; responseMimeType application/json required). Supported keywords: $id, $defs, $ref, $anchor, type (arrays like [\"string\",\"null\"]), format, title, description, enum, items, prefixItems, minItems, maxItems, minimum, maximum, anyOf, oneOf (=anyOf), properties, additionalProperties, required, plus non-standard propertyOrdering. Unsupported keywords are ignored. Cyclic $ref only in non-required properties; a $ref sub-schema may carry only $-keys.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/structured-output",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "d_json_response_json_schema: 200 → '{\\n  \"ok\": true,\\n  \"word\": \"OK' (MAX_TOKENS at 32; keys in schema order) | without mime: 200 — JSON produced even without responseMimeType (docs say mime is required; not enforced) | anyOf/$ref/$defs: 200 → '{\"w\": \"OK\"}' with $defs + $ref + anyOf [ref, null]"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig._responseJsonSchema",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Discovery lists this underscore-prefixed twin with the full description and marks `responseJsonSchema` as 'An internal detail' — a documentation quirk; send `responseJsonSchema`.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.responseFormat",
  "location": "body",
  "type": "ResponseFormatConfig {text:{mimeType: APPLICATION_JSON|TEXT_PLAIN, schema}, audio:{mimeType, sampleRate, bitRate, delivery}, image:{mimeType, aspectRatio, imageSize, delivery}}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "NEW flat per-modality output format (the current docs use it for structured output: `responseFormat.text.mimeType: \"application/json\"` + `schema`). Enum-style values (`APPLICATION_JSON`) are accepted on the wire; live test with the docs' lowercase MIME string: 400 'Invalid value at generation_config.response_format.text.mime_type (…TextResponseFormat.MimeType), \"application/json\"' — the wire enum is APPLICATION_JSON | TEXT_PLAIN; the docs' lowercase MIME strings only work through the SDKs. Audio/image branches are media-domain shapes.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/structured-output",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "d_response_format_new {text:{mimeType:'APPLICATION_JSON', schema}} → 200 '{\"ok\": true}'; TEXT_PLAIN: 200 'OK.' with responseFormat.text.mimeType TEXT_PLAIN | combined with responseMimeType: 200 JSON ('{\"response\": \"OK\"}') when responseFormat.text.mimeType APPLICATION_JSON is combined with responseMimeType application/json"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.responseModalities",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "MODALITY_UNSPECIFIED",
   "TEXT",
   "IMAGE",
   "AUDIO"
  ],
  "description": "Requested output modalities (exact match with a supported combination; empty = TEXT). Text models accept [TEXT]; [TEXT, IMAGE] on a text model: 200 — text model silently returned text only for [TEXT, IMAGE] (no error despite the documented 'exact match' rule).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "c_system_gencfg with [TEXT] 200"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.speechConfig",
  "location": "body",
  "type": "SpeechConfig {voiceConfig:{prebuiltVoiceConfig:{voiceName}}, multiSpeakerVoiceConfig:{speakerVoiceConfigs[{speaker, voiceConfig}]}, languageCode}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "TTS voice selection (shape only — media domain). On a text model: 200 — speechConfig ignored on a text model.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/speech-generation",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.imageConfig",
  "location": "body",
  "type": "ImageConfig {aspectRatio: 1:1|1:4|4:1|1:8|8:1|2:3|3:2|3:4|4:3|4:5|5:4|9:16|16:9|21:9, imageSize: 512|1K|2K|4K}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Image generation options (shape only — media domain). On a text model: 400 INVALID_ARGUMENT 'Aspect ratio is not enabled for this model' (imageConfig.aspectRatio on gemini-3.5-flash-lite).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/image-generation",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.mediaResolution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "MEDIA_RESOLUTION_UNSPECIFIED",
   "MEDIA_RESOLUTION_LOW",
   "MEDIA_RESOLUTION_MEDIUM",
   "MEDIA_RESOLUTION_HIGH"
  ],
  "description": "Global media resolution for all media parts (per-part override via parts[].mediaResolution on Gemini 3). Token budgets (Gemini 3): image LOW 280 / MEDIUM 560 / HIGH & default 1120 / ULTRA_HIGH 2240 (per-part only); video 70 (LOW/MEDIUM) / 280 (HIGH) per frame; PDF 280/560/1120 + native text; audio fixed 25/s. Observed on gemini-3.5-flash-lite 1×1 PNG: default 1089, LOW 256 IMAGE tokens. Ignored on text-only requests (200, ignored on text-only input). ULTRA_HIGH globally: 400 'Invalid value at generation_config.media_resolution (…GenerationConfig.MediaResolution), \"MEDIA_RESOLUTION_ULTRA_HIGH\"' — ULTRA_HIGH is per-part only.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/media-resolution",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "k_inline_png_low_res 256 vs 1089 tokens"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.thinkingConfig",
  "location": "body",
  "type": "ThinkingConfig {thinkingLevel, thinkingBudget, includeThoughts}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Reasoning controls. Error on models without thinking. thinkingLevel and thinkingBudget are mutually exclusive → 400 'You can only set only one of thinking budget and thinking level.'",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "e_level_and_budget_conflict 400"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.thinkingConfig.thinkingLevel",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "THINKING_LEVEL_UNSPECIFIED",
   "MINIMAL",
   "LOW",
   "MEDIUM",
   "HIGH"
  ],
  "description": "Gemini 3 reasoning depth (case-insensitive: 'low' and 'HIGH' both accepted). Defaults: high (3.1 Pro, 3 Flash), medium (3.5–3.8 Flash), minimal (3.5/3.1 Flash-Lite). Support: minimal NOT on 3.8/3.7 Flash or 3.1 Pro (400 'Thinking level MINIMAL is not supported for this model. Please retry with other thinking level.'); low/medium/high on all Gemini 3 text models; 3.1 Flash-Lite Image: minimal/high only. Not supported on 2.5 (use thinkingBudget). Unknown value → 400 'Invalid value at generation_config.thinking_config.thinking_level'.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "e_g38_level_low 200 (no thoughtsTokenCount); e_g38_level_high 200 thoughtsTokenCount 70 for 'Reply with OK.'; e_g38_level_minimal_unsupported 400; e_lite_level_minimal 200; e_flash_level_minimal: 200 on gemini-3.5-flash with thinkingLevel minimal (17.5 s latency, no thoughtsTokenCount)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.thinkingConfig.thinkingBudget",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Thinking-token budget (Gemini 2.5 style; accepted by 3.x for compatibility but not recommended). -1 = dynamic; 0 = off where allowed (2.5 Flash/Flash-Lite 0–24576, 2.5 Pro 128–32768 cannot disable). Gemini 3: 3.1 Pro cannot disable (429 RESOURCE_EXHAUSTED on gemini-3.1-pro-preview (free-tier quota for Pro exhausted/zero) — not verifiable on this key; docs: cannot disable thinking); 3.5 Flash-Lite budget 0 → 400 'Request contains an invalid argument.'; 3.5 Flash budget 0: 200 on gemini-3.5-flash with thinkingBudget 0: 'OK.', no thoughtsTokenCount (thinking off accepted, 5.7 s); over-large budget 100000 on Flash-Lite: 400 '* GenerateContentRequest.generation_config.thinking_config.thinking_budget: thinking_budget must be in the range [-1, 65535]'. The model may overflow/underflow the budget.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": [
    200,
    400
   ],
   "request_note": "e_flash_thoughts_budget 256 → thoughtsTokenCount 117; e_lite_budget_0 400; e_lite_budget_minus1 200 (60 thought tokens)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.thinkingConfig.includeThoughts",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Return thought summaries as parts with `thought: true` (before the answer part). Summaries appear only when the model reasoned enough; billing is on full thought tokens (thoughtsTokenCount), not the summary. Without it, thinking still happens and is billed.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/thinking",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "e_flash_thoughts_budget: 1 thought part ('**My Calculation of a Multiplication Problem**…') + answer '391'; e_g38_level_low with includeThoughts: no thought part (little reasoning); includeThoughts alone on Flash-Lite: 200, no thought part (model at default minimal level did not produce a summary)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.audioTimestamp",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "SDK field (GenerateContentConfig.audio_timestamp) for timestamp understanding of audio input. NOT present in the v1beta discovery GenerationConfig: 400 'Invalid JSON payload received. Unknown name \"audioTimestamp\" at generation_config: Cannot find field.' — SDK-only/Vertex field, rejected by the Gemini API.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/audio",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "failure",
   "http_status": 400,
   "request_note": "400 'Invalid JSON payload received. Unknown name \"audioTimestamp\" at generation_config: Cannot find field.' — SDK-only/Vertex field, rejected by the Gemini API"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.enableEnhancedCivicAnswers",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Enhanced answers on civic/election topics (replaces the deprecated HARM_CATEGORY_CIVIC_INTEGRITY setting); may be unavailable on some models.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content",
  "verification": {
   "method": "live_api",
   "verified_at": "2026-09-18",
   "result": "success",
   "http_status": 200,
   "request_note": "c_enhanced_civic: 200 on gemini-3.5-flash-lite (no visible effect on a harmless prompt)"
  },
  "last_verified": "2026-09-18",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.enableAffectiveDialog",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Model detects emotions and adapts (Live/native-audio models; discovery lists it on GenerationConfig).",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.audioTranscriptionConfig",
  "location": "body",
  "type": "AudioTranscriptionConfig {languageCodes[], languageHints, languageAuto, wordTimestamp, diarization, adaptationPhrases[], customVocabulary[], mode: VERBATIM|SMART}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Speech-recognition config for transcription models (gemini-3.5-transcribe) — shape only, media domain.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED",
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/transcribe",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.translationConfig",
  "location": "body",
  "type": "TranslationConfig {targetLanguageCode, echoTargetLanguage}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Translation config (Live translate model) — shape only, media domain.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.modelSelectionConfig / routingConfig / modelArmorConfig",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [],
  "description": "Present in the google-genai SDK GenerateContentConfig but NOT in the Gemini API discovery document — Vertex AI-only fields; sending them to generativelanguage.googleapis.com yields 400 Unknown name.",
  "compatible_models": [
   "all generateContent models unless noted"
  ],
  "beta_header": null,
  "status": [
   "UNVERIFIED"
  ],
  "source": "https://github.com/googleapis/python-genai (types.py)",
  "_fragment": "generated/fragments/parameters/gemini-generate-content.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.responseModalities",
  "location": "body",
  "type": "array<enum>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "AUDIO"
  ],
  "description": "TTS models: must be [\"AUDIO\"] (text-only input, audio-only output).",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview",
   "gemini-2.5-flash-preview-tts",
   "gemini-2.5-pro-preview-tts"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/speech-generation#single-speaker-tts",
  "notes": "Live 2026-09-18 'Say: OK' voice Kore: gemini-3.1-flash-tts-preview -> 200 audio/l16; rate=24000; channels=1 <46080 bytes> in 1.54 s (usage {\"promptTokenCount\": 3, \"candidatesTokenCount\": 31, \"totalTokenCount\": 34, \"promptTokensDetails\": [{\"modality\": \"TEXT\", \"tokenCount\": 3}], \"candidatesTokensDetails\": [{\"modality\": \"AUDIO\", \"tokenCount\": 31}], \"serviceTier\": \"standard\"}); gemini-2.5-flash-preview-tts -> 200 audio/L16;codec=pcm;rate=24000 <38926 bytes, base64 len 51904> (usage {\"promptTokenCount\": 3, \"candidatesTokenCount\": 20, \"totalTokenCount\": 23, \"promptTokensDetails\": [{\"modality\": \"TEXT\", \"tokenCount\": 3}], \"candidatesTokensDetails\": [{\"modality\": \"AUDIO\", \"tokenCount\": 20}], \"serviceTier\": \"standard\"}). Note the mimeType string differs between the two models.",
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.imageConfig",
  "location": "body",
  "type": "object (ImageConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image generation options. The API returns an error if set for models that do not support image generation.",
  "compatible_models": [
   "gemini-3.1-flash-lite-image",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3-pro-image-preview",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image-preview",
   "gemini-2.5-flash-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#ImageConfig",
  "notes": "Live: imageConfig on text model gemini-3.5-flash-lite -> HTTP 400 INVALID_ARGUMENT: Aspect ratio is not enabled for this model",
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.imageConfig.aspectRatio",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1:1",
   "1:4",
   "4:1",
   "1:8",
   "8:1",
   "2:3",
   "3:2",
   "3:4",
   "4:3",
   "4:5",
   "5:4",
   "9:16",
   "16:9",
   "21:9"
  ],
  "description": "Output aspect ratio. Default: matches the input image, otherwise 1:1. 1:4/4:1/1:8/8:1 only on gemini-3.1-flash-image; 2.5-flash-image and 3-pro-image support the 10 classic ratios.",
  "compatible_models": [
   "gemini-3.1-flash-lite-image",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3-pro-image-preview",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image-preview",
   "gemini-2.5-flash-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#ImageConfig",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.imageConfig.imageSize",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "1K",
  "minimum": null,
  "maximum": null,
  "enum": [
   "512",
   "1K",
   "2K",
   "4K"
  ],
  "description": "Output resolution. Uppercase K required (\"1k\" is rejected). 512 (0.5K) only on gemini-3.1-flash-image; gemini-3.1-flash-lite-image supports 1K only; gemini-3-pro-image 1K/2K/4K; gemini-2.5-flash-image fixed ~1024px (no imageSize).",
  "compatible_models": [
   "gemini-3.1-flash-lite-image",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3-pro-image-preview",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#ImageConfig",
  "notes": "Live: imageSize '1k' -> HTTP 429 RESOURCE_EXHAUSTED: You exceeded your current quota, please check your plan and billing details. For more information on this error, head to: https://ai.google.dev/gemini-api/docs/ | imageSize 4K on lite -> HTTP 429 RESOURCE_EXHAUSTED: You exceeded your current quota, please check your plan and billing details. For more information on this error, head to: https://ai.google.dev/gemini-api/docs/",
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.thinkingConfig.thinkingLevel",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "MINIMAL",
  "minimum": null,
  "maximum": null,
  "enum": [
   "MINIMAL",
   "HIGH"
  ],
  "description": "Thinking depth for Gemini 3.1 image models (thinking is always on and billed; cannot be disabled). Default MINIMAL for 3.1 Flash/Flash-Lite Image.",
  "compatible_models": [
   "gemini-3.1-flash-image",
   "gemini-3.1-flash-lite-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/image-generation#thinking-process",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.responseFormat.image",
  "location": "body",
  "type": "object (ImageResponseFormat)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Flat per-modality output format (newer alternative to imageConfig): mimeType (IMAGE_JPEG…), delivery (INLINE|URI), aspectRatio, imageSize enums.",
  "compatible_models": [
   "gemini-3.1-flash-lite-image",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3-pro-image-preview",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image-preview",
   "gemini-2.5-flash-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#ResponseFormatConfig",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].inlineData",
  "location": "body",
  "type": "object {mimeType, data(base64)}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reference/input images for editing and composition. Up to 14 reference images on Gemini 3 image models (3.1 Flash Lite: 14 objects; 3.1 Flash: 10 objects + 4 characters; 3 Pro: 6 objects + 5 characters + 3 style). 2.5-flash-image works best with <= 3.",
  "compatible_models": [
   "gemini-3.1-flash-lite-image",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3-pro-image-preview",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image-preview",
   "gemini-2.5-flash-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/image-generation#use-up-to-14-reference-images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].fileData",
  "location": "body",
  "type": "object {mimeType, fileUri}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Video (Files API URI or public YouTube URL) as multimodal reference for video-to-image generation. Only gemini-3.1-flash-image and gemini-3.1-flash-lite-image. Audio inputs are not supported by image models.",
  "compatible_models": [
   "gemini-3.1-flash-image",
   "gemini-3.1-flash-lite-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/image-generation#video-to-image",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearch",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Grounding with Google Search for image generation (real-time data). Not supported by gemini-3.1-flash-lite-image. gemini-3.1-flash-image adds Image Search grounding (search_types image_search in the Interactions API); search suggestions must be displayed.",
  "compatible_models": [
   "gemini-3.1-flash-image",
   "gemini-3-pro-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/image-generation#grounding-with-google-search",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents (multi-turn)",
  "location": "body",
  "type": "array<Content>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Multi-turn editing: resend the conversation (user text, model image part, new user instruction). Recommended way to iterate on an image.",
  "compatible_models": [
   "gemini-3.1-flash-lite-image",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3-pro-image-preview",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image-preview",
   "gemini-2.5-flash-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/image-generation#multi-turn-image-editing",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format",
  "location": "body",
  "type": "object|array (ResponseFormat)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Interactions API: {type:'image', mime_type:'image/jpeg', aspect_ratio, image_size} returns only images; pass an array [{type:'text'},{type:'image'}] for interleaved text+image.",
  "compatible_models": [
   "gemini-3.1-flash-lite-image",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3-pro-image-preview",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image-preview",
   "gemini-2.5-flash-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/image-generation#optional-configurations",
  "notes": "Cross-reference: Interactions API is documented by the interactions agent; the image guide uses it for all samples.",
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format.image_size",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "512",
   "1K",
   "2K",
   "4K"
  ],
  "description": "Image size (uppercase K).",
  "compatible_models": [
   "gemini-3.1-flash-lite-image",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3-pro-image-preview",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/interactions-api",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format.aspect_ratio",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1:1",
   "1:4",
   "4:1",
   "1:8",
   "8:1",
   "2:3",
   "3:2",
   "3:4",
   "4:3",
   "4:5",
   "5:4",
   "9:16",
   "16:9",
   "21:9"
  ],
  "description": "Aspect ratio for image output.",
  "compatible_models": [
   "gemini-3.1-flash-lite-image",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3-pro-image-preview",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image-preview",
   "gemini-2.5-flash-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/interactions-api",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.thinking_level",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "minimal",
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "high"
  ],
  "description": "Thinking level for 3.1 image models.",
  "compatible_models": [
   "gemini-3.1-flash-image",
   "gemini-3.1-flash-lite-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/image-generation#controlling-thinking-levels",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "previous_interaction_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Id of the previous interaction to continue server-side state (history only; tools/system_instruction/generation_config are interaction-scoped). 400 if the previous interaction is still in_progress. Agents additionally need `environment`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[].search_types",
  "location": "body",
  "type": "array<enum>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search",
   "image_search"
  ],
  "description": "Google Search tool: ['web_search','image_search']; image_search only on gemini-3.1-flash-image.",
  "compatible_models": [
   "gemini-3.1-flash-image"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/image-generation#image-search",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predict",
  "parameter": "instances[].prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Imagen text prompt (<= 480 tokens). Imagen models are SHUT DOWN in the Gemini API (imagen-4.0-* shut down 2026-08-17); `predict` is kept in the discovery document but no Imagen model is served.",
  "compatible_models": [
   "imagen-4.0-generate-001",
   "imagen-4.0-ultra-generate-001",
   "imagen-4.0-fast-generate-001"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/imagen",
  "notes": "Live: imagen-4.0-fast-generate-001:predict -> HTTP 404 NOT_FOUND: models/imagen-4.0-fast-generate-001 is not found for API version v1beta, or is not supported for predict. Call ModelService.ListModels to see the list of available models and their supported methods.",
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predict",
  "parameter": "parameters.sampleCount",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 4,
  "enum": null,
  "description": "Imagen: number of images (1-4). Historical; retired with Imagen.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/imagen",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predict",
  "parameter": "parameters.aspectRatio",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1:1",
   "3:4",
   "4:3",
   "9:16",
   "16:9"
  ],
  "description": "Imagen: 1:1, 3:4, 4:3, 9:16, 16:9. Historical; retired with Imagen.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/imagen",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predict",
  "parameter": "parameters.personGeneration",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "dont_allow",
   "allow_adult",
   "allow_all"
  ],
  "description": "Imagen: dont_allow | allow_adult | allow_all. Historical; retired with Imagen.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/imagen",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predict",
  "parameter": "parameters.imageSize",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1K",
   "2K"
  ],
  "description": "Imagen 4: 1K | 2K. Historical; retired with Imagen.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/imagen",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-image-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "x-goog-api-key",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Gemini API key. Never put the key in the URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "Api-Revision",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "2026-05-20",
   "2026-05-07"
  ],
  "description": "Schema revision header. `2026-05-20` = current steps/response_format schema (default since 2026-05-26); `2026-05-07` = legacy `outputs` schema (removed 2026-06-08).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/interactions-breaking-changes-may-2026",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "api_version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "v1beta",
   "v1"
  ],
  "description": "Which version of the API to use (path segment: v1beta | v1).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/interactions/{id}",
  "parameter": "x-goog-api-key",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Gemini API key. Never put the key in the URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/interactions/{id}",
  "parameter": "Api-Revision",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "2026-05-20",
   "2026-05-07"
  ],
  "description": "Schema revision header. `2026-05-20` = current steps/response_format schema (default since 2026-05-26); `2026-05-07` = legacy `outputs` schema (removed 2026-06-08).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/interactions-breaking-changes-may-2026",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/interactions/{id}",
  "parameter": "api_version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "v1beta",
   "v1"
  ],
  "description": "Which version of the API to use (path segment: v1beta | v1).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/interactions/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique identifier of the interaction (Interaction.id, e.g. `v1_Chd...`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/interactions/{id}",
  "parameter": "x-goog-api-key",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Gemini API key. Never put the key in the URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/interactions/{id}",
  "parameter": "Api-Revision",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "2026-05-20",
   "2026-05-07"
  ],
  "description": "Schema revision header. `2026-05-20` = current steps/response_format schema (default since 2026-05-26); `2026-05-07` = legacy `outputs` schema (removed 2026-06-08).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/interactions-breaking-changes-may-2026",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/interactions/{id}",
  "parameter": "api_version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "v1beta",
   "v1"
  ],
  "description": "Which version of the API to use (path segment: v1beta | v1).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/interactions/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique identifier of the interaction (Interaction.id, e.g. `v1_Chd...`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions/{id}/cancel",
  "parameter": "x-goog-api-key",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Gemini API key. Never put the key in the URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions/{id}/cancel",
  "parameter": "Api-Revision",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "2026-05-20",
   "2026-05-07"
  ],
  "description": "Schema revision header. `2026-05-20` = current steps/response_format schema (default since 2026-05-26); `2026-05-07` = legacy `outputs` schema (removed 2026-06-08).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/interactions-breaking-changes-may-2026",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions/{id}/cancel",
  "parameter": "api_version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "v1beta",
   "v1"
  ],
  "description": "Which version of the API to use (path segment: v1beta | v1).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions/{id}/cancel",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique identifier of the interaction (Interaction.id, e.g. `v1_Chd...`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/interactions/{id}",
  "parameter": "stream",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If true, the interaction is streamed incrementally as SSE (reconnect to a background interaction).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/interactions/{id}",
  "parameter": "last_event_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Resumes the interaction stream from the next chunk after the event with this event_id. Only with stream=true.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "model",
  "location": "body",
  "type": "string (ModelOption)",
  "required": "one of model|agent",
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gemini-2.5-flash",
   "gemini-2.5-pro",
   "gemma-4-26b-a4b-it",
   "gemma-4-31b-it",
   "gemini-flash-latest",
   "gemini-flash-lite-latest",
   "gemini-pro-latest",
   "gemini-2.5-flash-lite",
   "gemini-2.5-flash-image",
   "gemini-3-flash-preview",
   "gemini-3.1-pro-preview",
   "gemini-3.1-pro-preview-customtools",
   "gemini-3.1-flash-lite",
   "gemini-3-pro-image",
   "nano-banana-pro-preview",
   "gemini-3.1-flash-image",
   "gemini-3.5-flash",
   "gemini-3.6-flash",
   "gemini-3.7-flash",
   "gemini-3.8-flash",
   "lyria-3-clip-preview",
   "lyria-3-pro-preview",
   "gemini-robotics-er-1.6-preview",
   "gemini-robotics-er-2-preview"
  ],
  "description": "Name of the Model generating the interaction. Required if `agent` is not provided. Mutually exclusive with `agent`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "agent",
  "location": "body",
  "type": "string (AgentOption)",
  "required": "one of model|agent",
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "deep-research-pro-preview-12-2025",
   "deep-research-preview-04-2026",
   "deep-research-max-preview-04-2026",
   "antigravity-preview-05-2026",
   "antigravity-preview-09-2026",
   "<custom agent id>"
  ],
  "description": "Name of the Agent (managed agent id or custom agent id created via POST /v1beta/agents). Required if `model` is not provided.",
  "compatible_models": [
   "deep-research-pro-preview-12-2025",
   "deep-research-preview-04-2026",
   "deep-research-max-preview-04-2026",
   "antigravity-preview-05-2026",
   "antigravity-preview-09-2026",
   "<custom agent id>"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input",
  "location": "body",
  "type": "string | Content | Content[] | Step[]",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inputs for the interaction (common to model and agent). A plain string, a single Content block, an array of Content blocks (single user turn) or an array of Steps (full stateless history: user_input/model_output/function_call/function_result...).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "image",
   "audio",
   "document",
   "video",
   "user_input",
   "model_output",
   "function_call",
   "function_result",
   "thought",
   "code_execution_call",
   "code_execution_result",
   "google_search_call",
   "google_search_result",
   "google_maps_call",
   "google_maps_result",
   "url_context_call",
   "url_context_result",
   "file_search_call",
   "file_search_result",
   "mcp_server_tool_call",
   "mcp_server_tool_result",
   "processing_call",
   "processing_result"
  ],
  "description": "Discriminator of each input item. Content types: text, image, audio, document, video. Step types (history/tool results): user_input, model_output, function_call, function_result, thought, *_call/*_result server-tool steps.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](text).annotations[]",
  "location": "body",
  "type": "Annotation[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Citation annotations (file_citation | place_citation | url_citation | word_info). Output-side mostly.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](image).data",
  "location": "body",
  "type": "string (base64)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline image bytes (base64). Alternative to `uri`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](image).uri",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URI of the image (e.g. Files API URI).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](image).mime_type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image/png",
   "image/jpeg",
   "image/webp",
   "image/heic",
   "image/heif",
   "image/gif",
   "image/bmp",
   "image/tiff"
  ],
  "description": "Image MIME type.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](image).resolution",
  "location": "body",
  "type": "string (MediaResolution)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "ultra_high"
  ],
  "description": "Media resolution hint.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](audio).data",
  "location": "body",
  "type": "string (base64)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline audio bytes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](audio).uri",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URI of the audio.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](audio).mime_type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/wav",
   "audio/mp3",
   "audio/aiff",
   "audio/aac",
   "audio/ogg",
   "audio/flac",
   "audio/mpeg",
   "audio/m4a",
   "audio/l16",
   "audio/opus",
   "audio/alaw",
   "audio/mulaw",
   "audio/webm"
  ],
  "description": "Audio MIME type.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](audio).channels",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of audio channels.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](audio).sample_rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sample rate of the audio.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](document).data",
  "location": "body",
  "type": "string (base64)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline document bytes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](document).uri",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URI of the document.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](document).mime_type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/pdf",
   "text/csv"
  ],
  "description": "Document MIME type.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).data",
  "location": "body",
  "type": "string (base64)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline video bytes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).uri",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URI of the video (Files API URI or YouTube URL).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).mime_type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "video/mp4",
   "video/mpeg",
   "video/mpg",
   "video/mov",
   "video/avi",
   "video/x-flv",
   "video/webm",
   "video/wmv",
   "video/3gpp"
  ],
  "description": "Video MIME type.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-defined name for this content block; the model can reference it in the final response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).resolution",
  "location": "body",
  "type": "string (MediaResolution)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "ultra_high"
  ],
  "description": "Media resolution.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).processing",
  "location": "body",
  "type": "string | StaticMediaProcessing",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "static",
   "agentic"
  ],
  "description": "How the model processes the video: `\"agentic\"` (model-driven dynamic navigation) or `\"static\"` (fixed-rate frame extraction) or an object {type:'static', fps, start_offset, end_offset}.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).processing.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "static"
  ],
  "description": "Always `static` for the object form.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).processing.fps",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Frame-rate sampling density.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).processing.start_offset",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional segment start, decimal seconds with `s` suffix (e.g. \"10.5s\"). Non-negative.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](video).processing.end_offset",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional segment end, e.g. \"30s\"; must be > start_offset.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](user_input).content",
  "location": "body",
  "type": "Content[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Content blocks of a user turn (stateless history).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](model_output).content",
  "location": "body",
  "type": "Content[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Content blocks of a previous model turn (stateless history).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](function_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. Tool call id (echo back from the model's function_call step).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](function_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. Function name.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](function_call).arguments",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. Arguments object.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](function_result).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. Must match the `id` of the function_call step being answered.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](function_result).name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool that was called.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](function_result).result",
  "location": "body",
  "type": "string | object | (TextContent|ImageContent)[]",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. Result of the tool call (plain string, JSON object or rich content array).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](function_result).is_error",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the tool call resulted in an error.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](thought).signature",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Thought signature to replay (stateless multi-turn with thinking models).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "input[](thought).summary",
  "location": "body",
  "type": "(TextContent|ImageContent)[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Thought summary content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "system_instruction",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System instruction for this interaction (interaction-scoped: must be re-sent every turn; additive with AGENTS.md for agents).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools",
  "location": "body",
  "type": "Tool[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tool declarations the model/agent may call. Interaction-scoped (re-send each turn). Antigravity default set: code_execution, google_search, url_context; Deep Research default: google_search, url_context, code_execution.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "google_search",
   "google_maps",
   "code_execution",
   "url_context",
   "file_search",
   "mcp_server",
   "computer_use"
  ],
  "description": "Tool discriminator.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](function).name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Function name.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](function).description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Function description.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](function).parameters",
  "location": "body",
  "type": "object (JSON Schema)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON Schema of the function parameters.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](google_search).search_types",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search",
   "image_search"
  ],
  "description": "Types of search grounding to enable.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](google_maps).latitude",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User latitude.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](google_maps).longitude",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User longitude.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](google_maps).enable_widget",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return a widget context token in the tool result.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](file_search).file_search_store_names",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File search store names (`fileSearchStores/...`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](file_search).metadata_filter",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata filter for semantic retrieval.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](file_search).top_k",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of retrieval chunks.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](mcp_server).name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MCP server name (Antigravity: required, must match ^[a-z0-9_-]+$; uppercase → 400).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](mcp_server).url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full MCP endpoint URL (streamable HTTP; SSE transport unsupported for Antigravity).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](mcp_server).headers",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional auth headers etc. Merged on top of `credential`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](mcp_server).credential",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stored credential id injected by the egress proxy (agent-credentials guide; not in the reference page).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](mcp_server).allowed_tools",
  "location": "body",
  "type": "AllowedTools[] | string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Restrict callable tools. Reference: array of {mode, tools[]}; guides: list of tool names.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](mcp_server).allowed_tools[].mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "any",
   "none",
   "validated"
  ],
  "description": "Tool choice mode.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](mcp_server).allowed_tools[].tools",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Names of the allowed tools.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](computer_use).environment",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "browser",
   "mobile",
   "desktop"
  ],
  "description": "Environment being operated.",
  "compatible_models": [
   "gemini-2.5-computer-use-preview-10-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](computer_use).disabled_safety_policies",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "financial_transactions",
   "sensitive_data_modification",
   "communication_tool",
   "account_creation",
   "data_modification",
   "user_consent_management",
   "legal_terms_and_agreements"
  ],
  "description": "Disabled safety policies.",
  "compatible_models": [
   "gemini-2.5-computer-use-preview-10-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](computer_use).enable_prompt_injection_detection",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enable prompt-injection detection on computer-use requests.",
  "compatible_models": [
   "gemini-2.5-computer-use-preview-10-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "tools[](computer_use).excluded_predefined_functions",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Predefined functions excluded from the model call.",
  "compatible_models": [
   "gemini-2.5-computer-use-preview-10-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format",
  "location": "body",
  "type": "ResponseFormat | ResponseFormat[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Output format(s). Polymorphic on `type` (text | image | audio | video); pass an array for multiple output modalities. Replaces legacy `response_mime_type` and `generation_config.image_config` (May 2026 breaking change). Not supported by Deep Research / Antigravity agents.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "image",
   "audio",
   "video"
  ],
  "description": "Format discriminator.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(text).mime_type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/json",
   "text/plain"
  ],
  "description": "Text output MIME type.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(text).schema",
  "location": "body",
  "type": "object (JSON Schema)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON schema the output must conform to (only with mime_type application/json).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(image).aspect_ratio",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1:1",
   "2:3",
   "3:2",
   "3:4",
   "4:3",
   "4:5",
   "5:4",
   "9:16",
   "16:9",
   "21:9",
   "1:8",
   "8:1",
   "1:4",
   "4:1"
  ],
  "description": "Image aspect ratio.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(image).image_size",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "512",
   "1K",
   "2K",
   "4K"
  ],
  "description": "Image size.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(image).mime_type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image/jpeg"
  ],
  "description": "Image output MIME type.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(image).delivery",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline",
   "uri"
  ],
  "description": "Inline base64 or URI.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(audio).mime_type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/mp3",
   "audio/ogg_opus",
   "audio/l16",
   "audio/wav",
   "audio/alaw",
   "audio/mulaw"
  ],
  "description": "Audio output MIME type.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(audio).sample_rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sample rate in Hz.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(audio).bit_rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Bit rate (bps), compressed formats only.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(audio).delivery",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline",
   "uri"
  ],
  "description": "Inline or URI.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(video).aspect_ratio",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "16:9",
   "9:16"
  ],
  "description": "Video aspect ratio.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(video).resolution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "720p",
  "minimum": null,
  "maximum": null,
  "enum": [
   "360p",
   "720p",
   "1080p",
   "4k"
  ],
  "description": "Video resolution. Defaults to 720p.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(video).duration",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Video duration.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format(video).delivery",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline",
   "uri"
  ],
  "description": "Inline or URI.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "stream",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Input only. Stream the response as SSE (InteractionSseEvent).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "store",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Input only. Store request+response for retrieval / previous_interaction_id. Default true. Retention: paid tier 55 days (configurable 7/14/28/55 in AI Studio), free tier 1 day. `store=false` is incompatible with `background=true` and prevents chaining via previous_interaction_id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/interactions-overview",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "background",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Input only. Run asynchronously; returns immediately with status queued/in_progress; poll GET or stream GET ?stream=true. Requires store=true. Mandatory in practice for deep-research-* agents.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/background-execution",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "labels",
  "location": "body",
  "type": "object (map<string,string>)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-defined metadata labels for the request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "safety_settings",
  "location": "body",
  "type": "SafetySetting[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Safety settings. NOTE: the overview says custom safety settings are NOT supported in the Interactions API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "service_tier",
  "location": "body",
  "type": "string (ServiceTier)",
  "required": false,
  "default": "standard",
  "minimum": null,
  "maximum": null,
  "enum": [
   "flex",
   "standard",
   "priority"
  ],
  "description": "Inference tier: flex (50% price, best-effort, 429/503 when full, no fallback), standard, priority (+75-100% price, 0.3x rate limit, graceful downgrade; check `x-gemini-service-tier` response header).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/flex-inference",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "webhook_config",
  "location": "body",
  "type": "WebhookConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Dynamic webhook for completion events (interaction.completed/failed/cancelled/requires_action) signed with JWKS asymmetric keys.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "webhook_config.uris",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Webhook URIs used instead of the registered static webhooks.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "webhook_config.user_metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata returned on each webhook event emission.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config",
  "location": "body",
  "type": "GenerationConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model configuration. Only when `model` is set (alternative to agent_config). Interaction-scoped.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.max_output_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum tokens in the response. Not supported by Antigravity (400).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.seed",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Decoding seed for reproducibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.stop_sequences",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stop sequences. Not supported by Antigravity (400).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sampling temperature (shown in the text-generation guide `generation_config: {temperature: 1.0}`; ABSENT from the reference page's GenerationConfig list). Unsupported by Antigravity (400).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/text-generation",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.top_p",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Nucleus sampling (mentioned in breaking-changes and antigravity limitations, not in the reference page).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.top_k",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Top-k sampling (mentioned in antigravity limitations only).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.thinking_level",
  "location": "body",
  "type": "string (ThinkingLevel)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high"
  ],
  "description": "Amount of thinking (Gemini 3 family).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.thinking_summaries",
  "location": "body",
  "type": "string (ThinkingSummaries)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "none"
  ],
  "description": "Include thought summaries (`thought` steps with `summary`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.tool_choice",
  "location": "body",
  "type": "string | ToolChoiceConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "any",
   "none",
   "validated"
  ],
  "description": "Tool choice: enum or {allowed_tools:{mode, tools[]}}.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.tool_choice.allowed_tools.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "any",
   "none",
   "validated"
  ],
  "description": "Mode for the allowed tools.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.tool_choice.allowed_tools.tools",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Names of the allowed tools.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.speech_config",
  "location": "body",
  "type": "SpeakerConfig | SpeechConfig[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Speech / multi-speaker TTS configuration.",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview",
   "gemini-2.5-flash-preview-tts",
   "gemini-2.5-pro-preview-tts"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.speech_config.speakers[].speaker",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Speaker name matching the prompt.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.speech_config.speakers[].voice",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Voice name.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.speech_config.speakers[].language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Language of the speech.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.transcription_config",
  "location": "body",
  "type": "TranscriptionConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Speech recognition (ASR) configuration; presence enables transcription.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.transcription_config.custom_vocabulary",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Phrases to bias recognition.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.transcription_config.language_codes",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "BCP-47 hints; empty = auto-detect.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.transcription_config.mode",
  "location": "body",
  "type": "string | SmartTranscriptionMode | VerbatimTranscriptionMode",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "verbatim",
   "smart"
  ],
  "description": "Transcription mode enum or object.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.transcription_config.mode.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "smart",
   "verbatim"
  ],
  "description": "Object-form discriminator.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.transcription_config.mode(verbatim).diarization_mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "speaker"
  ],
  "description": "Speaker diarization. Supported: \"speaker\".",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.transcription_config.mode(verbatim).timestamp_granularities",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "word"
  ],
  "description": "Timestamp granularity. Supported: \"word\".",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.video_config.task",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text_to_video",
   "image_to_video",
   "reference_to_video",
   "edit",
   "extend"
  ],
  "description": "Video generation task mode (auto if omitted).",
  "compatible_models": [
   "veo-*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "agent_config",
  "location": "body",
  "type": "AntigravityAgentConfig | DeepResearchAgentConfig | DynamicAgentConfig | CodeMenderAgentConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agent configuration. Only when `agent` is set (alternative to generation_config). Discriminator `type`. CodeMenderAgentConfig is named in the union but has no documented fields.",
  "compatible_models": [
   "deep-research-pro-preview-12-2025",
   "deep-research-preview-04-2026",
   "deep-research-max-preview-04-2026",
   "antigravity-preview-05-2026",
   "antigravity-preview-09-2026",
   "<custom agent id>"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "agent_config.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "antigravity",
   "deep-research",
   "dynamic"
  ],
  "description": "Agent config discriminator.",
  "compatible_models": [
   "deep-research-pro-preview-12-2025",
   "deep-research-preview-04-2026",
   "deep-research-max-preview-04-2026",
   "antigravity-preview-05-2026",
   "antigravity-preview-09-2026",
   "<custom agent id>"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "agent_config(antigravity).model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "gemini-3.8-flash",
  "minimum": null,
  "maximum": null,
  "enum": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite"
  ],
  "description": "Underlying Gemini model for the Antigravity agent (default gemini-3.8-flash). Locked for named custom agents.",
  "compatible_models": [
   "antigravity-preview-09-2026",
   "antigravity-preview-05-2026"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "agent_config(antigravity).max_total_tokens",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Budget: max total (input+output+thinking, excluding cached) tokens for the run; best-effort; exceeding → status `incomplete` (continue with previous_interaction_id + environment). Reference types it as string, guides pass an integer (50000).",
  "compatible_models": [
   "antigravity-preview-09-2026",
   "antigravity-preview-05-2026"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "agent_config(deep-research).collaborative_planning",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-in-the-loop planning: agent returns a research plan; proceeds only after confirmation in the next turn (set false/omit to approve).",
  "compatible_models": [
   "deep-research-preview-04-2026",
   "deep-research-max-preview-04-2026",
   "deep-research-pro-preview-12-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/deep-research",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "agent_config(deep-research).thinking_summaries",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "none"
  ],
  "description": "Include thought summaries.",
  "compatible_models": [
   "deep-research-preview-04-2026",
   "deep-research-max-preview-04-2026",
   "deep-research-pro-preview-12-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "agent_config(deep-research).visualization",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "off",
   "auto"
  ],
  "description": "Allow charts/graphs (image deltas) in the report; agent only generates them when prompted.",
  "compatible_models": [
   "deep-research-preview-04-2026",
   "deep-research-max-preview-04-2026"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment",
  "location": "body",
  "type": "string | EnvironmentConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sandbox for agent interactions: `\"remote\"` (fresh sandbox), an existing environment id (reuse files/packages), or an EnvironmentConfig object. Returned as `environment_id` on the Interaction. Required alongside previous_interaction_id when chaining managed agents.",
  "compatible_models": [
   "antigravity-preview-09-2026",
   "antigravity-preview-05-2026",
   "<custom agent id>"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "remote"
  ],
  "description": "Always `remote`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.environment_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Update an existing environment (e.g. refresh network rules) instead of creating one.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.sources[]",
  "location": "body",
  "type": "Source[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files to mount at creation. Limits: repository 500 MB, gcs 2 GB, inline 1 MB/file and 2 MB total. Target must not be `/`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.sources[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gcs",
   "inline",
   "repository"
  ],
  "description": "Source kind.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.sources[].source",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "GCS path (gs://...) or repository URL (github://, https://github.com/...).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.sources[].target",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Where the source appears in the sandbox (e.g. /workspace/repo, .agents/AGENTS.md, .agents/skills/<name>/SKILL.md, .agents/hooks.json).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.sources[].content",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline content when type=inline.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.sources[].encoding",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional encoding for inline content (e.g. base64).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.network",
  "location": "body",
  "type": "string | EnvironmentNetworkEgressAllowlist",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "disabled"
  ],
  "description": "Outbound network: omit = unrestricted; `\"disabled\"` = no egress; object {allowlist[]} = only listed domains (add {domain:'*'} as catch-all). New rules fully replace previous ones for a reused environment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.network.allowlist[].domain",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Exact host or wildcard (`*.example.com` does NOT match the root; `*` = all).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.network.allowlist[].credential",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stored credential id; the egress proxy injects its header on requests to this domain.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.network.allowlist[].transform",
  "location": "body",
  "type": "object | object[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Headers to inject on matching requests (e.g. {Authorization: 'Bearer ...'}); merged over `credential` (transform wins on conflict).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.env",
  "location": "body",
  "type": "object (map<string, string | {credential}>)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment variables in the sandbox: literal strings (plaintext, readable by the agent) or `{\"credential\": \"<id>\"}` references (placeholder `__GEMINI_CRED_<id>__`, substituted by the proxy only towards the credential's trusted_domains).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.env.<NAME>.credential",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reference to an environment_variable credential id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "environment.env.<NAME>.value",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Direct string value (reference-page object form).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique credential id (UUID generated if omitted; lowercase alphanumerics/hyphens/underscores recommended). 409 `aborted` if it exists.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "bearer_token",
   "oauth2",
   "environment_variable"
  ],
  "description": "Credential type (fixed at creation).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "token",
  "location": "body",
  "type": "string",
  "required": "bearer_token",
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "bearer_token: the static token. Write-only.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "header_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "Authorization",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "bearer_token: header to inject. Default Authorization.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "prefix",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "Bearer",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "bearer_token: value prefix. Default `Bearer`; `\"\"` for none.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "client_id",
  "location": "body",
  "type": "string",
  "required": "oauth2",
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "oauth2: client id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "client_secret",
  "location": "body",
  "type": "string",
  "required": "oauth2",
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "oauth2: client secret. Write-only.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "refresh_token",
  "location": "body",
  "type": "string",
  "required": "oauth2",
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "oauth2: refresh token (live exchange at creation). Write-only.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "token_url",
  "location": "body",
  "type": "string",
  "required": "oauth2",
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "oauth2: token endpoint URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "scopes",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "oauth2: scopes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "value",
  "location": "body",
  "type": "string",
  "required": "environment_variable",
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "environment_variable: the secret value. Write-only.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "injection_location",
  "location": "body",
  "type": "string | string[]",
  "required": "environment_variable",
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "header",
   "query",
   "body"
  ],
  "description": "environment_variable: where the proxy substitutes the placeholder.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/credentials",
  "parameter": "trusted_domains",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "environment_variable: domain patterns authorized for substitution.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/credentials",
  "parameter": "page_size",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 50,
  "minimum": null,
  "maximum": 1000,
  "enum": null,
  "description": "Max credentials to return. Default 50, max 1000.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/credentials",
  "parameter": "page_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination token (next_page_token of previous response).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/credentials/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Credential id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Credential id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/credentials/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Credential id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "update_mask",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. List of fields to update.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "bearer_token",
   "oauth2",
   "environment_variable"
  ],
  "description": "Must match the existing type (cannot change).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "token",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `token` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "header_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `header_name` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "prefix",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `prefix` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "client_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `client_id` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "client_secret",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `client_secret` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "refresh_token",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `refresh_token` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "token_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `token_url` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "scopes",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `scopes` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "value",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `value` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "injection_location",
  "location": "body",
  "type": "string | string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `injection_location` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/credentials/{id}",
  "parameter": "trusted_domains",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional new value for `trusted_domains` (same semantics as create).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-credentials",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/agents",
  "parameter": "id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique agent id in the project; used as `agent` in interactions. Reserved prefixes forbidden (antigravity-, veo-, omni-, lyria-, imagen-, gemma-, gemini-, google-, youtube-, android-, chrome-, pixel-, waze-, fitbit-, nest-, kaggle-).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/agents",
  "parameter": "description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable description.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/agents",
  "parameter": "base_agent",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "antigravity-preview-09-2026",
   "antigravity-preview-05-2026"
  ],
  "description": "Base managed agent. Guide: only `antigravity-preview-09-2026`; reference example: `antigravity-preview-05-2026`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/agents",
  "parameter": "agent_config",
  "location": "body",
  "type": "AntigravityAgentConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Base agent configuration incl. model. Default gemini-3.8-flash. Cannot be overridden at interaction time for named agents.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/agents",
  "parameter": "agent_config.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "antigravity"
  ],
  "description": "`antigravity`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/agents",
  "parameter": "agent_config.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "gemini-3.8-flash",
  "minimum": null,
  "maximum": null,
  "enum": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite"
  ],
  "description": "Model for the agent.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/agents",
  "parameter": "system_instruction",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System prompt / persona (overridable per interaction).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/agents",
  "parameter": "tools",
  "location": "body",
  "type": "Tool[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default tools (code_execution, google_search, url_context if omitted); supports mcp_server and function (overridable per interaction).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/agents",
  "parameter": "base_environment",
  "location": "body",
  "type": "string | EnvironmentConfig",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`\"remote\"`, an environment_id (fork), or {type:'remote', sources[], network}. Each invocation forks it.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/agents",
  "parameter": "page_size",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Page size (SDK ListAgentsParams).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/agents",
  "parameter": "page_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Page token (SDK ListAgentsParams).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/interactions",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/agents/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agent id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/agents/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agent id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/custom-agents",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/triggers",
  "parameter": "schedule",
  "location": "body",
  "type": "string (cron)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cron expression, e.g. `0 9 * * 1-5`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/triggers",
  "parameter": "time_zone",
  "location": "body",
  "type": "string (IANA)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "IANA time zone.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/triggers",
  "parameter": "display_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable name.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/triggers",
  "parameter": "max_consecutive_failures",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 5,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Failures before auto-pause. Default 5.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/triggers",
  "parameter": "execution_timeout_seconds",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 600,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Timeout per execution. Default 600.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/triggers",
  "parameter": "interaction",
  "location": "body",
  "type": "CreateInteractionRequest",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The agent interaction to run (agent, input, tools, environment ...).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/triggers/{id}",
  "parameter": "status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "paused",
   "active"
  ],
  "description": "Pause (`paused`) or resume (`active`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/triggers/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Trigger id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/triggers/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Trigger id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/triggers/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Trigger id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/triggers/{id}/executions",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Trigger id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/triggers/{id}/executions",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Trigger id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/antigravity-agent",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1/webhooks",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Webhook display name.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1/webhooks",
  "parameter": "uri",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "HTTPS listener URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1/webhooks",
  "parameter": "subscribed_events",
  "location": "body",
  "type": "string[]",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "interaction.requires_action",
   "interaction.completed",
   "interaction.failed",
   "interaction.cancelled",
   "batch.succeeded",
   "batch.cancelled",
   "batch.expired",
   "batch.failed",
   "video.generated"
  ],
  "description": "Events to deliver.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1/webhooks/{id}",
  "parameter": "subscribed_events",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replace subscribed events.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1/webhooks/{id}/rotate_secret",
  "parameter": "revocation_behavior",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "REVOKE_PREVIOUS_SECRETS_AFTER_H24"
  ],
  "description": "When to revoke previous secrets.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1/webhooks/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Webhook id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1/webhooks/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Webhook id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1/webhooks/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Webhook id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1/webhooks/{id}/rotate_secret",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Webhook id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "sources[]",
  "location": "body",
  "type": "Source[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sources to mount (REST page snake_case; discovery `sources`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "sources[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gcs",
   "inline",
   "repository"
  ],
  "description": "Source kind.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "sources[].source",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "GCS path or repository URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "sources[].target",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Mount target inside the environment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "sources[].content",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline content (type=inline).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "sources[].encoding",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional inline encoding (base64).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "network",
  "location": "body",
  "type": "string | EnvironmentNetworkEgressAllowlist",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "disabled"
  ],
  "description": "REST page: `disabled` or {allowlist[]}. Discovery doc splits this into `networkMode` (NETWORK_MODE_UNSPECIFIED | DISABLED) and `networkAllowlist`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "network.allowlist[].domain",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Allowed domain (wildcards, `*`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "network.allowlist[].credential",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stored credential id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "network.allowlist[].transform",
  "location": "body",
  "type": "object | object[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Headers to inject.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "from_environment",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Fork/copy from `environments/{id}` or `{id}`; sources/env must be empty. Discovery: `fromEnvironment`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "networkMode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "NETWORK_MODE_UNSPECIFIED",
   "DISABLED"
  ],
  "description": "Discovery-doc camelCase field: network egress mode.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "networkAllowlist",
  "location": "body",
  "type": "EnvironmentNetworkEgressAllowlist",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Discovery-doc camelCase field: {allowlist: EgressRule[]}.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/environments",
  "parameter": "fromEnvironment",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Discovery-doc camelCase alias of from_environment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/environments",
  "parameter": "page_size",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 50,
  "minimum": null,
  "maximum": 1000,
  "enum": null,
  "description": "Max environments (default 50, max 1000). Discovery/guide: `pageSize`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/environments",
  "parameter": "page_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination token. Discovery: `pageToken`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/environments/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment id (discovery: resource ID segment of `environments/{id}`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "DELETE /v1beta/environments/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment id (discovery: resource ID segment of `environments/{id}`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/environments/{environment}/files/{path}",
  "parameter": "environment",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment id (`parent` = environments/{environment_id} in discovery).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/environments/{environment}/files/{path}",
  "parameter": "path",
  "location": "path",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File or directory path relative to the workspace; empty = root.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/environments/{environment}/files/{path}",
  "parameter": "alt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "media"
  ],
  "description": "`media` → raw file bytes (file) or POSIX tar (directory).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/environments/{environment}/files/{path}",
  "parameter": "recursive",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Recurse into subdirectories (listing or tar).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/environments/{environment}/files/{path}",
  "parameter": "page_size",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 100,
  "minimum": null,
  "maximum": 1000,
  "enum": null,
  "description": "Directory listing page size. Default 100, max 1000.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/environments/{environment}/files/{path}",
  "parameter": "page_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Directory listing page token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "environment",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "path",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Destination relative path (e.g. workspace/data/file.txt; directory with trailing `/` for extract).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "extract",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Treat the body as tar/tar.gz and unpack into `path`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "overwrite",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Overwrite existing file(s); otherwise 409 Conflict.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "Content-Type",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the uploaded bytes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/agent-environment",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "<body>",
  "location": "file",
  "type": "bytes",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": "2147483648 bytes",
  "enum": null,
  "description": "Raw file or archive bytes (`--data-binary @file`). Max 2 GiB (discovery mediaUpload.maxSize).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "X-Goog-Upload-Protocol",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "resumable"
  ],
  "description": "Resumable protocol selector (`resumable`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "X-Goog-Upload-Command",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "start"
  ],
  "description": "`start` to open a resumable session (URL returned in X-Goog-Upload-URL).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "X-Goog-Upload-Header-Content-Length",
  "location": "header",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Total bytes to be uploaded to the session URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PUT /upload/v1beta/environments/{environment}/files/{path}",
  "parameter": "X-Goog-Upload-Header-Content-Type",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "MIME type of the bytes uploaded to the session URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://ai.google.dev/api/environments",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/files/environment-{environment}:download",
  "parameter": "alt",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "media"
  ],
  "description": "`media` (required to get the tar).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/managed-agents-quickstart",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/dynamic/{dynamicId}:generateContent",
  "parameter": "model",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Resource name `dynamic/{dynamicId}` (pattern ^dynamic/[^/]+$).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED",
   "DOCUMENTATION_INCOMPLETE"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/dynamic/{dynamicId}:generateContent",
  "parameter": "<body>",
  "location": "body",
  "type": "GenerateContentRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Same body as models/*:generateContent (contents, tools, generationConfig, systemInstruction, safetySettings, cachedContent, toolConfig). Semantics of `dynamic/*` undocumented.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED",
   "DOCUMENTATION_INCOMPLETE"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/dynamic/{dynamicId}:streamGenerateContent",
  "parameter": "model",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Resource name `dynamic/{dynamicId}` (pattern ^dynamic/[^/]+$).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED",
   "DOCUMENTATION_INCOMPLETE"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/dynamic/{dynamicId}:streamGenerateContent",
  "parameter": "<body>",
  "location": "body",
  "type": "GenerateContentRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Same body as models/*:generateContent (contents, tools, generationConfig, systemInstruction, safetySettings, cachedContent, toolConfig). Semantics of `dynamic/*` undocumented.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED",
   "DOCUMENTATION_INCOMPLETE"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/dynamic/{dynamicId}:streamGenerateContent",
  "parameter": "alt",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "sse"
  ],
  "description": "`sse` for server-sent-events framing (as for models).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "_fragment": "generated/fragments/parameters/gemini-interactions.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "key",
  "location": "query",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard API key as WebSocket URL query parameter (`?key=YOUR_API_KEY`) — the documented raw-WebSocket auth. Server-side only; never ship in clients. (The project convention prefers the x-goog-api-key header for REST; for WSS the docs show the query param.)",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/get-started-websocket",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "access_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ephemeral token (AuthToken.name) as query parameter on the v1beta `BidiGenerateContentConstrained` WebSocket URL (`?access_token=<token>`). Alternative: HTTP header `Authorization: Token <token>`. Ephemeral tokens work only with the Live API, v1beta.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "Authorization",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`Authorization: Token <ephemeral token>` — header alternative to ?access_token for ephemeral tokens (RFC 7235 auth-scheme `Token`).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup",
  "location": "body",
  "type": "object (BidiGenerateContentSetup)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "First and only-first client message. Wait for setupComplete before sending more.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`models/{model}` resource name.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig",
  "location": "body",
  "type": "object (GenerationConfig subset)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unsupported in Live: responseLogprobs, responseMimeType, logprobs, responseSchema, responseJsonSchema, stopSequence(s), skipResponseCache, routingConfig, audioTimestamp.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.responseModalities[]",
  "location": "body",
  "type": "enum[]",
  "required": false,
  "default": "[\"AUDIO\"] (SDK)",
  "minimum": null,
  "maximum": null,
  "enum": [
   "TEXT",
   "AUDIO"
  ],
  "description": "Output modalities. Native audio agent + translate models: [\"AUDIO\"] only (text via outputAudioTranscription); gemini-3.5-transcribe-live: [\"TEXT\"]. SDK default AUDIO.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.speechConfig",
  "location": "body",
  "type": "object (SpeechConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Voice/language for audio output.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.speechConfig.voiceConfig",
  "location": "body",
  "type": "object (VoiceConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Single-voice configuration.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.speechConfig.voiceConfig.prebuiltVoiceConfig",
  "location": "body",
  "type": "object (PrebuiltVoiceConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Prebuilt voice selection.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.speechConfig.voiceConfig.prebuiltVoiceConfig.voiceName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "Zephyr",
   "Puck",
   "Charon",
   "Kore",
   "Fenrir",
   "Leda",
   "Orus",
   "Aoede",
   "Callirrhoe",
   "Autonoe",
   "Enceladus",
   "Iapetus",
   "Umbriel",
   "Algieba",
   "Despina",
   "Erinome",
   "Algenib",
   "Rasalgethi",
   "Laomedeia",
   "Achernar",
   "Alnilam",
   "Schedar",
   "Gacrux",
   "Pulcherrima",
   "Achird",
   "Zubenelgenubi",
   "Vindemiatrix",
   "Sadachbia",
   "Sadaltager",
   "Sulafat"
  ],
  "description": "Any Gemini TTS voice (30): Zephyr, Puck, Charon, Kore, Fenrir, Leda, Orus, Aoede, Callirrhoe, Autonoe, Enceladus, Iapetus, Umbriel, Algieba, Despina, Erinome, Algenib, Rasalgethi, Laomedeia, Achernar, Alnilam, Schedar, Gacrux, Pulcherrima, Achird, Zubenelgenubi, Vindemiatrix, Sadachbia, Sadaltager, Sulafat.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.speechConfig.languageCode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "BCP-47 output language (de-DE, en-AU, en-GB, en-IN, en-US, es-US, fr-FR, hi-IN, pt-BR, ar-XA, es-ES, fr-CA, id-ID, it-IT, ja-JP, tr-TR, vi-VN, bn-IN, gu-IN, kn-IN, ml-IN, mr-IN, ta-IN, te-IN, nl-NL, ko-KR, cmn-CN, pl-PL, ru-RU, th-TH). Native audio output models pick the language automatically and do not support setting it — effect on current models UNVERIFIED (steer via system instructions).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.speechConfig.multiSpeakerVoiceConfig",
  "location": "body",
  "type": "object (MultiSpeakerVoiceConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Multi-speaker TTS config (speakerVoiceConfigs[]{speaker, voiceConfig}); mutually exclusive with voiceConfig. Not documented for Live.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.mediaResolution",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "MEDIA_RESOLUTION_UNSPECIFIED",
   "MEDIA_RESOLUTION_LOW",
   "MEDIA_RESOLUTION_MEDIUM",
   "MEDIA_RESOLUTION_HIGH"
  ],
  "description": "Visual input token allocation per frame (LOW 64, MEDIUM 256, HIGH zoomed 256). Audio tokenization unaffected.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.thinkingConfig",
  "location": "body",
  "type": "object (ThinkingConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Thinking configuration. gemini-3.8-live: not supported (omit). Error on models without thinking.",
  "compatible_models": [
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/thinking",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.thinkingConfig.thinkingLevel",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "MINIMAL (3.1); model-dependent",
  "minimum": null,
  "maximum": null,
  "enum": [
   "THINKING_LEVEL_UNSPECIFIED",
   "MINIMAL",
   "LOW",
   "MEDIUM",
   "HIGH"
  ],
  "description": "gemini-3.1-flash-live-preview: MINIMAL (default) | LOW | MEDIUM | HIGH. gemini-3.8-live-extended-thinking: LOW | MEDIUM | HIGH (MINIMAL unsupported). gemini-3.8-live: unsupported.",
  "compatible_models": [
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.thinkingConfig.thinkingBudget",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Thinking token budget (0 disabled, -1 automatic) — Gemini 2.5 native-audio thinking; replaced by thinkingLevel on 3.1+.",
  "compatible_models": [
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/models/gemini-3.1-flash-live-preview",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.thinkingConfig.includeThoughts",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Include thought summaries in modelTurn parts.",
  "compatible_models": [
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.enableAffectiveDialog",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Adapt style/tone to the user's expression. Gemini 2.5 native audio (v1beta) only; not supported on 3.1; removed on 3.8 (remove from code).",
  "compatible_models": [
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.translationConfig",
  "location": "body",
  "type": "object (TranslationConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Live translation settings (translate model only).",
  "compatible_models": [
   "gemini-3.5-live-translate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/live-translate",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.translationConfig.targetLanguageCode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "en",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required for translation: BCP-47 target language (\"en\", \"es\", \"pl\" ...). Guide default \"en\".",
  "compatible_models": [
   "gemini-3.5-live-translate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/live-translate",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.translationConfig.echoTargetLanguage",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "true: parrot input already in the target language; false: stay silent for it.",
  "compatible_models": [
   "gemini-3.5-live-translate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/live-translate",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard GenerationConfig field listed in the Live session-configuration example (seed: SDK LiveConnectConfig).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.topP",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard GenerationConfig field listed in the Live session-configuration example (seed: SDK LiveConnectConfig).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.topK",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard GenerationConfig field listed in the Live session-configuration example (seed: SDK LiveConnectConfig).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.maxOutputTokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard GenerationConfig field listed in the Live session-configuration example (seed: SDK LiveConnectConfig).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.candidateCount",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard GenerationConfig field listed in the Live session-configuration example (seed: SDK LiveConnectConfig).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.presencePenalty",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard GenerationConfig field listed in the Live session-configuration example (seed: SDK LiveConnectConfig).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.frequencyPenalty",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard GenerationConfig field listed in the Live session-configuration example (seed: SDK LiveConnectConfig).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.generationConfig.seed",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard GenerationConfig field listed in the Live session-configuration example (seed: SDK LiveConnectConfig).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.systemInstruction",
  "location": "body",
  "type": "object (Content)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System instructions; text parts only, each part a separate paragraph. Recommended to specify the language here.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.systemInstruction.parts[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Instruction text.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[]",
  "location": "body",
  "type": "object[] (Tool)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tools: functionDeclarations, googleSearch. codeExecution, urlContext, googleMaps: not supported on current Live models. Translate/transcribe models: no tools.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/tools",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].functionDeclarations[]",
  "location": "body",
  "type": "object[] (FunctionDeclaration)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Client-executed functions (name, description, parameters | parametersJsonSchema, behavior, response | responseJsonSchema).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/tools",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].functionDeclarations[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "a-z A-Z 0-9 _ - : . ; max 128.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].functionDeclarations[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Function description.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].functionDeclarations[].parameters",
  "location": "body",
  "type": "object (Schema)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OpenAPI-style parameters schema (type OBJECT, properties, required).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].functionDeclarations[].parametersJsonSchema",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON Schema alternative (mutually exclusive with parameters).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].functionDeclarations[].behavior",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "model-dependent (NON_BLOCKING on 3.8)",
  "minimum": null,
  "maximum": null,
  "enum": [
   "UNSPECIFIED",
   "BLOCKING",
   "NON_BLOCKING"
  ],
  "description": "Live-only. BLOCKING waits for the response; NON_BLOCKING lets the conversation continue. Defaults: gemini-3.8-live NON_BLOCKING (BLOCKING allowed); gemini-3.8-live-extended-thinking NON_BLOCKING only (BLOCKING = hard error); gemini-3.1-flash-live-preview synchronous only; Gemini 2.5 both.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].functionDeclarations[].response",
  "location": "body",
  "type": "object (Schema)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Response schema (optional).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].googleSearch",
  "location": "body",
  "type": "object {}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Grounding with Google Search; results in serverContent.groundingMetadata. 5,000 free searches/month then $14 / 1,000 (3.x).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/tools",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].codeExecution",
  "location": "body",
  "type": "object {}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Listed as NOT supported for Live models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/tools",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.tools[].urlContext",
  "location": "body",
  "type": "object {}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Listed as NOT supported for Live models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/tools",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.realtimeInputConfig",
  "location": "body",
  "type": "object (RealtimeInputConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Realtime input behaviour (VAD, interruption, turn coverage).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.realtimeInputConfig.automaticActivityDetection",
  "location": "body",
  "type": "object (AutomaticActivityDetection)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Server-side VAD (enabled by default when absent).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.realtimeInputConfig.automaticActivityDetection.disabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "true = manual VAD: client sends realtimeInput.activityStart / activityEnd; audioStreamEnd not used.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.realtimeInputConfig.automaticActivityDetection.startOfSpeechSensitivity",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "START_SENSITIVITY_HIGH",
  "minimum": null,
  "maximum": null,
  "enum": [
   "START_SENSITIVITY_UNSPECIFIED",
   "START_SENSITIVITY_HIGH",
   "START_SENSITIVITY_LOW"
  ],
  "description": "Start-of-speech sensitivity.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.realtimeInputConfig.automaticActivityDetection.endOfSpeechSensitivity",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "END_SENSITIVITY_HIGH",
  "minimum": null,
  "maximum": null,
  "enum": [
   "END_SENSITIVITY_UNSPECIFIED",
   "END_SENSITIVITY_HIGH",
   "END_SENSITIVITY_LOW"
  ],
  "description": "End-of-speech sensitivity.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.realtimeInputConfig.automaticActivityDetection.prefixPaddingMs",
  "location": "body",
  "type": "integer (int32)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Speech duration before start-of-speech is committed (look-back); 0 may clip word onsets.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.realtimeInputConfig.automaticActivityDetection.silenceDurationMs",
  "location": "body",
  "type": "integer (int32)",
  "required": false,
  "default": "≈800 (server internal)",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Silence before end-of-speech is committed; server default ≈ 800 ms; recommended 500-800; too low fragments utterances, too high adds latency.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.realtimeInputConfig.activityHandling",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "START_OF_ACTIVITY_INTERRUPTS",
  "minimum": null,
  "maximum": null,
  "enum": [
   "ACTIVITY_HANDLING_UNSPECIFIED",
   "START_OF_ACTIVITY_INTERRUPTS",
   "NO_INTERRUPTION"
  ],
  "description": "START_OF_ACTIVITY_INTERRUPTS (default, barge-in) or NO_INTERRUPTION.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.realtimeInputConfig.turnCoverage",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "model-dependent",
  "minimum": null,
  "maximum": null,
  "enum": [
   "TURN_COVERAGE_UNSPECIFIED",
   "TURN_INCLUDES_ONLY_ACTIVITY",
   "TURN_INCLUDES_ALL_INPUT",
   "TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO"
  ],
  "description": "Input included in the user turn. Default: Gemini 2.5 TURN_INCLUDES_ONLY_ACTIVITY; Gemini 3.1+ TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO (all video frames billed).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.inputAudioTranscription",
  "location": "body",
  "type": "object (AudioTranscriptionConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Presence enables user-audio transcription -> serverContent.inputTranscription (+ interimInputTranscription on transcribe model). `{}` = defaults (auto language).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.inputAudioTranscription.languageCodes[]",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": "[] (auto)",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "BCP-47 hints; empty/omitted = auto-detect (multilingual).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/live-transcribe",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.inputAudioTranscription.customVocabulary[]",
  "location": "body",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 1000,
  "enum": null,
  "description": "Up to 1,000 biasing terms (best ≤ 100).",
  "compatible_models": [
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/live-transcribe",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.inputAudioTranscription.mode",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "VERBATIM",
  "minimum": null,
  "maximum": null,
  "enum": [
   "MODE_UNSPECIFIED",
   "VERBATIM",
   "SMART"
  ],
  "description": "VERBATIM (default) or SMART (filler removal, formatting, self-corrections). Incompatible with word annotations.",
  "compatible_models": [
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/live-transcribe",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.inputAudioTranscription.wordTimestamp",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Word-level timestamps — not supported over the Live API (unary gemini-3.5-transcribe only).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/live-transcribe",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.inputAudioTranscription.diarization",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Speaker diarization — not supported over the Live API.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/live-transcribe",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.outputAudioTranscription",
  "location": "body",
  "type": "object (AudioTranscriptionConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Presence enables model-audio transcription -> serverContent.outputTranscription (language inferred from the response). Same sub-fields as inputAudioTranscription. Transcript text tokens billed at text output rate.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.sessionResumption",
  "location": "body",
  "type": "object (SessionResumptionConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Presence makes the server send sessionResumptionUpdate. `{}` for a new resumable session.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/session-management",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.sessionResumption.handle",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Handle from a previous sessionResumptionUpdate.newHandle to resume; absent = new session. Valid 2 h after last termination. Config (except model) may change on resume.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/session-management",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.sessionResumption.transparent",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK-only: request lastConsumedClientMessageIndex in updates for transparent reconnects. Not in REST reference.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.contextWindowCompression",
  "location": "body",
  "type": "object (ContextWindowCompressionConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enable sliding-window compression to lift the 15-min audio / 2-min audio+video session limits (unlimited duration).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/session-management",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.contextWindowCompression.slidingWindow",
  "location": "body",
  "type": "object (SlidingWindow)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sliding-window mechanism (union compressionMechanism). `{}` accepts defaults.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/session-management",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.contextWindowCompression.slidingWindow.targetTokens",
  "location": "body",
  "type": "integer (int64; JSON string or number)",
  "required": false,
  "default": "triggerTokens/2",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tokens kept after compression. Default triggerTokens/2; must be < triggerTokens.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.contextWindowCompression.triggerTokens",
  "location": "body",
  "type": "integer (int64; JSON string or number)",
  "required": false,
  "default": "80% of context window",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Context size (before a turn) that triggers compression. Default 80% of the model context window.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.proactivity",
  "location": "body",
  "type": "object (ProactivityConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Proactive audio configuration.",
  "compatible_models": [
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.proactivity.proactiveAudio",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": "false (2.5) / always true (3.8)",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model may ignore irrelevant/incomplete speech. Gemini 2.5: opt-in (v1beta). gemini-3.8-live*: permanently enabled; false returns an error. gemini-3.1-flash-live-preview: unsupported. Billing: input tokens charged the whole time the API listens.",
  "compatible_models": [
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.historyConfig",
  "location": "body",
  "type": "object (HistoryConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Initial-history handshake configuration.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.historyConfig.initialHistoryInClientContent",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If true, after setupComplete the server ingests clientContent (may end with role model) until turnComplete=true without calling the model; then realtimeInput begins.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.labels",
  "location": "body",
  "type": "object<string,string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Discovery schema only (not on the public reference): user labels, e.g. {\"safety_identifier\": \"user_session_123\"}; keys/values ≤ 63 chars, lowercase, digits, _ -.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.explicitVadSignal",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK-only (LiveClientSetup.explicit_vad_signal): client sends VAD signals; server emits voiceActivityDetectionSignal ('allowlisted only').",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "setup.safetySettings[]",
  "location": "body",
  "type": "object[] (SafetySetting)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK-only on LiveClientSetup/LiveConnectConfig; not on the public Live reference.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "clientContent",
  "location": "body",
  "type": "object (BidiGenerateContentClientContent)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Incremental conversation update; interrupts current generation.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "clientContent.turns[]",
  "location": "body",
  "type": "object[] (Content)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Turns appended to history (single or multi-turn). Roles user/model supported throughout the session (3.1+).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "clientContent.turns[].role",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "model"
  ],
  "description": "user | model",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "clientContent.turns[].parts[]",
  "location": "body",
  "type": "object[] (Part)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "text / inlineData / functionCall / functionResponse parts.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "clientContent.turnComplete",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "true = generate now (unconditionally interrupts); false/absent = server waits for more messages.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput",
  "location": "body",
  "type": "object (BidiGenerateContentRealtimeInput)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Realtime streams; one sub-field per message.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.audio",
  "location": "body",
  "type": "object (Blob)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Audio chunk.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.audio.mimeType",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "audio/pcm;rate=16000",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`audio/pcm;rate=16000` (or the actual sample rate; server resamples). Raw 16-bit LE PCM mono.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.audio.data",
  "location": "body",
  "type": "string (base64)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Base64 PCM bytes; send 20-100 ms chunks.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/best-practices",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.video",
  "location": "body",
  "type": "object (Blob)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Single image frame (≤ 1 FPS).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.video.mimeType",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image/jpeg",
   "image/png"
  ],
  "description": "image/jpeg or image/png.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/get-started-websocket",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.video.data",
  "location": "body",
  "type": "string (base64)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Base64 image bytes.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/get-started-websocket",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Realtime text stream.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/get-started-websocket",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.activityStart",
  "location": "body",
  "type": "object {}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Manual VAD: start of user activity (requires automaticActivityDetection.disabled=true).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.activityEnd",
  "location": "body",
  "type": "object {}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Manual VAD: end of user activity; server finalizes immediately.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.audioStreamEnd",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Automatic-VAD only: mic off / hybrid-VAD end-of-speech -> flush & finalize. Resume by sending audio.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/capabilities",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.mediaResolution",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "MEDIA_RESOLUTION_UNSPECIFIED",
   "MEDIA_RESOLUTION_LOW",
   "MEDIA_RESOLUTION_MEDIUM",
   "MEDIA_RESOLUTION_HIGH"
  ],
  "description": "Per-message override of setup.generationConfig.mediaResolution.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "realtimeInput.mediaChunks[]",
  "location": "body",
  "type": "object[] (Blob)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "DEPRECATED; only first chunk used. Use audio/video/text.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "toolResponse",
  "location": "body",
  "type": "object (BidiGenerateContentToolResponse)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Function results for a toolCall.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/tools",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "toolResponse.functionResponses[]",
  "location": "body",
  "type": "object[] (FunctionResponse)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "One per functionCall, matched by id.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "toolResponse.functionResponses[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "= FunctionCall.id.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "toolResponse.functionResponses[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "= FunctionCall.name.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "toolResponse.functionResponses[].response",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON result (\"output\"/\"result\"/\"error\" keys of your choice). Docs examples also place `scheduling` inside `response` for SDK convenience.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "toolResponse.functionResponses[].scheduling",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "WHEN_IDLE",
  "minimum": null,
  "maximum": null,
  "enum": [
   "SCHEDULING_UNSPECIFIED",
   "SILENT",
   "WHEN_IDLE",
   "INTERRUPT"
  ],
  "description": "NON_BLOCKING only: INTERRUPT | WHEN_IDLE (default) | SILENT. gemini-3.8-live-extended-thinking: scheduling not supported.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/tools",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "toolResponse.functionResponses[].willContinue",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "NON_BLOCKING only: more responses will follow (generator); false ends the call (pair with scheduling=SILENT to avoid triggering generation).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent",
  "parameter": "toolResponse.functionResponses[].parts[]",
  "location": "body",
  "type": "object[] (FunctionResponsePart)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Multimodal response parts (inlineData/fileData).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "x-goog-api-key",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Standard API key header (server side). Body content-type application/json.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "uses",
  "location": "body",
  "type": "integer (int32)",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of sessions the token can start; 0 = unlimited; default 1. Resuming does not count.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "expireTime",
  "location": "body",
  "type": "string (RFC 3339)",
  "required": false,
  "default": "now + 30 minutes",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When messages in sessions using the token stop being accepted (session may be closed). Default now+30 min; must be < 20 h ahead.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "newSessionExpireTime",
  "location": "body",
  "type": "string (RFC 3339)",
  "required": false,
  "default": "now + 60 seconds",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "After this, new sessions with the token are rejected. Default now+60 s; must be < 20 h ahead.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "fieldMask",
  "location": "body",
  "type": "string (FieldMask, comma-separated paths)",
  "required": false,
  "default": "",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Controls merge of bidiGenerateContentSetup with the client's setup: empty & no setup = client's; empty & setup = token's only; non-empty = listed fields overwrite. SDK: lock_additional_fields.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "bidiGenerateContentSetup",
  "location": "body",
  "type": "object (BidiGenerateContentSetup)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Locked Live setup (union `config`), same fields as the WebSocket setup message (model, generationConfig, systemInstruction, tools, ...).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "bidiGenerateContentSetup.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`models/{model}` locked model.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/api/live",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "liveConnectConstraints",
  "location": "body",
  "type": "object {model, config}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Shape used in official REST curl examples (and SDK live_connect_constraints): model + SDK-style config (responseModalities, sessionResumption, systemInstruction, tools, translationConfig, inputAudioTranscription ...). Not in the discovery AuthToken schema — REST acceptance UNVERIFIED; the SDK converts it to bidiGenerateContentSetup + fieldMask.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "liveConnectConstraints.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model to lock (`models/gemini-3.8-live` in REST examples; bare id in SDK).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "liveConnectConstraints.config",
  "location": "body",
  "type": "object (LiveConnectConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Config to lock; e.g. {\"sessionResumption\": {}, \"responseModalities\": [\"AUDIO\"]}. Fields omitted here can be set by the client only if unlocked (lock_additional_fields: []).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "config.uses",
  "location": "sdk-config",
  "type": "integer",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK (python client.auth_tokens.create(config=...) / node client.authTokens.create({config})): same as uses.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "config.expire_time",
  "location": "sdk-config",
  "type": "datetime | ISO string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK: expire_time (python) / expireTime (node).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "config.new_session_expire_time",
  "location": "sdk-config",
  "type": "datetime | ISO string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK: new_session_expire_time / newSessionExpireTime.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "config.live_connect_constraints",
  "location": "sdk-config",
  "type": "object (LiveConnectConstraints)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK: live_connect_constraints / liveConnectConstraints {model, config}.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/ephemeral-tokens",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "config.lock_additional_fields",
  "location": "sdk-config",
  "type": "string[]",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK: extra LiveConnectParameters fields to lock (translate guide: set [] to leave translationConfig settable client-side). Maps to fieldMask.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://ai.google.dev/gemini-api/docs/live-api/live-translate",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/auth_tokens",
  "parameter": "config.http_options",
  "location": "sdk-config",
  "type": "object (HttpOptions)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK: HTTP overrides (e.g. api_version 'v1beta').",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-3.1-flash-live-preview",
   "gemini-2.5-flash-native-audio-preview-12-2025",
   "gemini-2.5-flash-native-audio-preview-09-2025",
   "gemini-2.5-flash-native-audio-latest",
   "gemini-3.5-live-translate-preview",
   "gemini-3.5-transcribe-live"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
   "retrieved_at": "2026-09-18"
  },
  "_fragment": "generated/fragments/parameters/gemini-live.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].inlineData (image)",
  "location": "body",
  "type": "object {mimeType,data}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 10,
  "enum": null,
  "description": "Up to 10 images alongside the text prompt; the model composes music inspired by the visuals (Lyria 3.5).",
  "compatible_models": [
   "lyria-3.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/music-generation#generate-music-from-images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "response_format",
  "location": "body",
  "type": "object {type:'audio'}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Interactions API: request WAV output instead of default MP3 (lyria-3.5).",
  "compatible_models": [
   "lyria-3.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/music-generation#select-output-format",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "setup.model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "First (and only first) client message: {\"setup\":{\"model\":\"models/lyria-realtime-exp\"}}. Wait for setupComplete before sending anything else.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "clientContent.weightedPrompts[]",
  "location": "body",
  "type": "array<{text, weight}>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Weighted prompts steering the music; weight != 0, weights normalized, 1.0 is a good start. Can be re-sent any time; model transitions smoothly.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#prompt-lyria-realtime",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.guidance",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 4.0,
  "minimum": 0.0,
  "maximum": 6.0,
  "enum": null,
  "description": "Prompt adherence; higher = closer but more abrupt transitions.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.bpm",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 60,
  "maximum": 200,
  "enum": null,
  "description": "Beats per minute; requires RESET_CONTEXT (or stop/play) to take effect.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.density",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0.0,
  "maximum": 1.0,
  "enum": null,
  "description": "Note/sound density.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.brightness",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0.0,
  "maximum": 1.0,
  "enum": null,
  "description": "Tonal brightness (higher frequencies).",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.scale",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "SCALE_UNSPECIFIED",
   "C_MAJOR_A_MINOR",
   "D_FLAT_MAJOR_B_FLAT_MINOR",
   "D_MAJOR_B_MINOR",
   "E_FLAT_MAJOR_C_MINOR",
   "E_MAJOR_D_FLAT_MINOR",
   "F_MAJOR_D_MINOR",
   "G_FLAT_MAJOR_E_FLAT_MINOR",
   "G_MAJOR_E_MINOR",
   "A_FLAT_MAJOR_F_MINOR",
   "A_MAJOR_G_FLAT_MINOR",
   "B_FLAT_MAJOR_G_MINOR",
   "B_MAJOR_A_FLAT_MINOR"
  ],
  "description": "Key/mode (relative major/minor pairs); requires RESET_CONTEXT.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#scale-enum-values",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.muteBass",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reduce bass.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.muteDrums",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reduce drums.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.onlyBassAndDrums",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only bass and drums.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.musicGenerationMode",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "QUALITY",
  "minimum": null,
  "maximum": null,
  "enum": [
   "QUALITY",
   "DIVERSITY",
   "VOCALIZATION"
  ],
  "description": "QUALITY (default) | DIVERSITY | VOCALIZATION (vocalizations as an instrument).",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1.1,
  "minimum": 0.0,
  "maximum": 3.0,
  "enum": null,
  "description": "Sampling temperature.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.topK",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 40,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "Top-k sampling.",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "musicGenerationConfig.seed",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 2147483647,
  "enum": null,
  "description": "Seed (random by default).",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#controls",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WS BidiGenerateMusic",
  "parameter": "playbackControl",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "PLAY",
   "PAUSE",
   "STOP",
   "RESET_CONTEXT"
  ],
  "description": "PLAY starts generation; PAUSE holds; STOP stops and resets context (prompts kept); RESET_CONTEXT resets without stopping (needed after bpm/scale changes). The whole musicGenerationConfig must be re-sent on update (fields not sent reset to defaults).",
  "compatible_models": [
   "lyria-realtime-exp"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/realtime-music-generation#update-the-configuration",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-music.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.speechConfig.voiceConfig.prebuiltVoiceConfig.voiceName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "Zephyr",
   "Puck",
   "Charon",
   "Kore",
   "Fenrir",
   "Leda",
   "Orus",
   "Aoede",
   "Callirrhoe",
   "Autonoe",
   "Enceladus",
   "Iapetus",
   "Umbriel",
   "Algieba",
   "Despina",
   "Erinome",
   "Algenib",
   "Rasalgethi",
   "Laomedeia",
   "Achernar",
   "Alnilam",
   "Schedar",
   "Gacrux",
   "Pulcherrima",
   "Achird",
   "Zubenelgenubi",
   "Vindemiatrix",
   "Sadachbia",
   "Sadaltager",
   "Sulafat"
  ],
  "description": "One of the 30 prebuilt voices (single speaker).",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview",
   "gemini-2.5-flash-preview-tts",
   "gemini-2.5-pro-preview-tts"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/speech-generation#voice-options",
  "notes": "Live: voiceName 'NotAVoice' -> HTTP 400 INVALID_ARGUMENT: No matching speaker voice found for name: NotAVoice and language: ",
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.speechConfig.multiSpeakerVoiceConfig.speakerVoiceConfigs[]",
  "location": "body",
  "type": "array<{speaker, voiceConfig}>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 2,
  "enum": null,
  "description": "Multi-speaker TTS: up to 2 speakers; `speaker` must match the names used in the prompt. Mutually exclusive with voiceConfig.",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview",
   "gemini-2.5-flash-preview-tts",
   "gemini-2.5-pro-preview-tts"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/speech-generation#multi-speaker-tts",
  "notes": "Live 2026-09-18 gemini-2.5-flash-preview-tts Joe/Jane (Kore/Puck): first attempt with a 2-line 'OK?' script returned 200 but candidates[0] = {finishReason: OTHER} with NO content (silently empty); retry with the documented conversation -> 200 audio/L16;codec=pcm;rate=24000 <154126 bytes> (~3.2 s), usage {\"promptTokenCount\": 31, \"candidatesTokenCount\": 80, \"totalTokenCount\": 111, \"promptTokensDetails\": [{\"modality\": \"TEXT\", \"tokenCount\": 31}], \"candidatesTokensDetails\": [{\"modality\": \"AUDIO\", \"tokenCount\": 80}], \"serviceTier\": \"standard\"}. Always check for a missing content/parts.",
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:streamGenerateContent?alt=sse",
  "parameter": "generationConfig.responseModalities",
  "location": "body",
  "type": "array<enum>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "AUDIO"
  ],
  "description": "Streaming TTS (gemini-3.1-flash-tts-preview only): SSE `data:` events each carrying one inlineData audio chunk; the final event has finishReason STOP and full usageMetadata.",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/speech-generation#streaming-speech-generation",
  "notes": "Live 2026-09-18: 26 SSE events in 1.01 s; first chunk [1920] bytes ['audio/l16; rate=24000; channels=1']; last event finishReason STOP, usage {\"promptTokenCount\": 3, \"candidatesTokenCount\": 50, \"totalTokenCount\": 53, \"promptTokensDetails\": [{\"modality\": \"TEXT\", \"tokenCount\": 3}], \"candidatesTokensDetails\": [{\"modality\": \"AUDIO\", \"tokenCount\": 50}], \"serviceTier\": \"standard\"}; total 48000 PCM bytes.",
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.speechConfig.languageCode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional BCP-47 code; TTS auto-detects the input language (80+ languages listed).",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview",
   "gemini-2.5-flash-preview-tts",
   "gemini-2.5-pro-preview-tts"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#SpeechConfig",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.responseFormat.audio",
  "location": "body",
  "type": "object (AudioResponseFormat)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Flat output format: mimeType (AUDIO_MP3|AUDIO_OGG_OPUS|AUDIO_L16|AUDIO_WAV|AUDIO_ALAW|AUDIO_MULAW), delivery (INLINE|URI), sampleRate, bitRate. Default output is raw PCM L16 24 kHz mono.",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview",
   "gemini-2.5-flash-preview-tts",
   "gemini-2.5-pro-preview-tts"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#AudioResponseFormat",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:streamGenerateContent",
  "parameter": "alt=sse",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Streaming TTS is supported only from gemini-3.1-flash-tts-preview (streamGenerateContent / Interactions stream:true).",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/speech-generation#streaming-speech-generation",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.speech_config[]",
  "location": "body",
  "type": "array<{speaker?, voice, language?}>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Interactions API TTS config: [{voice:'Kore'}] or [{speaker:'Joe', voice:'Kore'},{speaker:'Jane', voice:'Puck'}] with response_format {type:'audio'}.",
  "compatible_models": [
   "gemini-3.1-flash-tts-preview",
   "gemini-2.5-flash-preview-tts",
   "gemini-2.5-pro-preview-tts"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/speech-generation#single-speaker-tts",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].inlineData|fileData (audio)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "gemini-3.5-transcribe input: audio (WAV, MP3, AIFF, AAC, OGG, FLAC, MPEG, M4A, L16, Opus, ALAW, MULAW, WebM), up to 1 h (30 min with diarization/timestamps). Use the Files API for anything longer than a few seconds.",
  "compatible_models": [
   "gemini-3.5-transcribe"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/transcribe",
  "notes": "Live 2026-09-18: 0.5 s silence WAV inlineData -> HTTP 200: {\"candidates\": [{\"content\": {}, \"finishReason\": \"STOP\", \"index\": 0}], \"usageMetadata\": {\"promptTokenCount\": 13, \"totalTokenCount\": 13, \"promptTokensDetails\": [{\"modality\": \"AUDIO\", \"tokenCount\": 13}],",
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.audioTranscriptionConfig.languageCodes",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "BCP-47 hints (85+ locales, e.g. en-US, fr-FR, cmn-Hans-CN). Empty/omitted = automatic detection with code-switching.",
  "compatible_models": [
   "gemini-3.5-transcribe"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#AudioTranscriptionConfig",
  "notes": "Live: audioTranscriptionConfig{mode:SMART, languageCodes:[en-US]} -> HTTP 200: {\"candidates\": [{\"content\": {}, \"finishReason\": \"STOP\", \"index\": 0}], \"usageMetadata\": {\"promptTokenCount\": 13, \"totalTokenCount\": 13, \"promptTokensDetails\": [{\"modality\": \"AUDIO\", \"tokenCount\": 13}],",
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.audioTranscriptionConfig.mode",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": "VERBATIM",
  "minimum": null,
  "maximum": null,
  "enum": [
   "VERBATIM",
   "SMART"
  ],
  "description": "VERBATIM (default: fillers, repetitions kept) or SMART (disfluency removal, inline self-corrections, structured formatting). SMART is incompatible with timestamps and diarization.",
  "compatible_models": [
   "gemini-3.5-transcribe"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#AudioTranscriptionConfig",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.audioTranscriptionConfig.customVocabulary",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 1000,
  "enum": null,
  "description": "Up to 1,000 bias terms (best <= 100). Incompatible with diarization and word timestamps (request rejected).",
  "compatible_models": [
   "gemini-3.5-transcribe"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/transcribe#custom-vocabulary",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.audioTranscriptionConfig.adaptationPhrases",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Discovery-document alias of speech adaptation phrases (same purpose as customVocabulary).",
  "compatible_models": [
   "gemini-3.5-transcribe"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.audioTranscriptionConfig.diarization",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Speaker diarization (labels spk_1..spk_8 in the Interactions docs; generateContent returned speakerLabel 'spk:0'; 3+ speakers experimental).",
  "compatible_models": [
   "gemini-3.5-transcribe"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#AudioTranscriptionConfig",
  "notes": "Live 2026-09-18 (0.8 s TTS 'OK' WAV, diarization+wordTimestamp+languageCodes en-US) -> 200 parts[0] = {\"parts\": [{\"text\": \"Okay.\", \"audioTranscription\": {\"text\": \"Okay.\", \"speakerLabel\": \"spk:0\", \"words\": [{\"word\": \"Okay.\", \"startOffset\": \"0.200s\", \"endOffset\": \"0.500s\"}]}}], \"role\": \"model\"} | SMART+customVocabulary+diarization -> HTTP 400 INVALID_ARGUMENT: Transcription mode SMART is incompatible with diarization.",
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "generationConfig.audioTranscriptionConfig.wordTimestamp",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Word-level start/end offsets (may reduce accuracy). Returned in parts[].audioTranscription.words[] {word, startOffset, endOffset} (LIVE_DISCOVERED shape).",
  "compatible_models": [
   "gemini-3.5-transcribe"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#AudioTranscriptionConfig",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/interactions",
  "parameter": "generation_config.transcription_config",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Interactions API form: {language_codes[], custom_vocabulary[], mode: 'smart' | {type:'verbatim', diarization_mode:'speaker', timestamp_granularities:['word']}}. Word annotations come back as word_info annotations on the text block.",
  "compatible_models": [
   "gemini-3.5-transcribe"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/transcribe#parameter-reference",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-speech.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].functionDeclarations",
  "location": "body",
  "type": "array<FunctionDeclaration>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. A list of `FunctionDeclarations` available to the model that can be used for function calling. The model or system does not execute the function. Instead the defined function may be returned as a FunctionCall with arguments to the client side for execution. The model may decide to call a subset of these functions by populating FunctionCall in the response. The next conversation turn may contain a FunctionResponse with the Content.role \"function\" generation context for the next model turn. Max 512 declarations (SDK docstring).",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionDeclaration",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].functionDeclarations[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The name of the function. Must be a-z, A-Z, 0-9, or contain underscores, colons, dots, and dashes, with a maximum length of 128. (FunctionCall.name is limited to letters, digits, underscores and dashes.)",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionDeclaration",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].functionDeclarations[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required (REST reference). Required. A brief description of the function. The model relies on it to choose the function; be specific.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionDeclaration",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].functionDeclarations[].parameters",
  "location": "body",
  "type": "object (Schema, OpenAPI 3.03 subset)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Describes the parameters to this function. Reflects the Open API 3.03 Parameter Object string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. Supported Schema fields: type, format, title, description, nullable, enum, items, minItems, maxItems, properties, required, minProperties, maxProperties, minimum, maximum, minLength, maxLength, pattern, anyOf, propertyOrdering, default, example. Mutually exclusive with parametersJsonSchema.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionDeclaration",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].functionDeclarations[].parametersJsonSchema",
  "location": "body",
  "type": "object (JSON Schema)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { \"type\": \"object\", \"properties\": { \"name\": { \"type\": \"string\" }, \"age\": { \"type\": \"integer\" } }, \"additionalProperties\": false, \"required\": [\"name\", \"age\"], \"propertyOrdering\": [\"name\", \"age\"] } ``` This field is mutually exclusive with `parameters`.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionDeclaration",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].functionDeclarations[].response",
  "location": "body",
  "type": "object (Schema)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. Mutually exclusive with responseJsonSchema.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionDeclaration",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].functionDeclarations[].responseJsonSchema",
  "location": "body",
  "type": "object (JSON Schema)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionDeclaration",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent (setup.tools) — ignored by generateContent",
  "parameter": "tools[].functionDeclarations[].behavior",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "BLOCKING",
  "minimum": null,
  "maximum": null,
  "enum": [
   "UNSPECIFIED",
   "BLOCKING",
   "NON_BLOCKING"
  ],
  "description": "Optional. Specifies the function Behavior. Currently only supported by the BidiGenerateContent method. REST reference: defaults to BLOCKING. Live API: NON_BLOCKING = asynchronous function calling (default on gemini-3.8-live; the only mode on gemini-3.8-live-extended-thinking; unsupported on gemini-3.1-flash-live-preview).",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-3.8-live-extended-thinking",
   "gemini-2.5-flash-native-audio-preview-12-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#Behavior",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearch",
  "location": "body",
  "type": "object (GoogleSearch)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. Empty object enables web search grounding.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite",
   "gemini-3.1-flash-image",
   "gemini-3-pro-image",
   "gemini-3.8-live",
   "gemini-3.1-flash-live-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#GoogleSearch",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearch.timeRangeFilter",
  "location": "body",
  "type": "object (Interval)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Filter search results to a specific time range. If customers set a start time, they must set an end time (and vice versa).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#GoogleSearch",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearch.timeRangeFilter.startTime",
  "location": "body",
  "type": "string (RFC 3339 timestamp)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#Interval",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearch.timeRangeFilter.endTime",
  "location": "body",
  "type": "string (RFC 3339 timestamp)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#Interval",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearch.searchTypes",
  "location": "body",
  "type": "object (SearchTypes)",
  "required": false,
  "default": "web search only",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The set of search types to enable. If not set, web search is enabled by default.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#SearchTypes",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearch.searchTypes.webSearch",
  "location": "body",
  "type": "object (WebSearch, empty)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Enables web search. Only text results are returned.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#SearchTypes",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearch.searchTypes.imageSearch",
  "location": "body",
  "type": "object (ImageSearch, empty)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Enables image search. Image bytes are returned. Documented for image generation (gemini-3.1-flash-image); cannot search for people.",
  "compatible_models": [
   "gemini-3.1-flash-image",
   "gemini-3.1-flash-image-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/image-generation",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearchRetrieval",
  "location": "body",
  "type": "object (GoogleSearchRetrieval)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Retrieval tool that is powered by Google search. LEGACY: for Gemini 1.5/2.0 models only ('Older models use a google_search_retrieval tool. For all current models, use the google_search tool'). 2.0 models shut down 2026-06-01.",
  "compatible_models": [
   "gemini-2.0-flash (RETIRED)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "DEPRECATED"
  ],
  "source": "https://ai.google.dev/api/generate-content#GoogleSearchRetrieval",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearchRetrieval.dynamicRetrievalConfig",
  "location": "body",
  "type": "object (DynamicRetrievalConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the dynamic retrieval configuration for the given source.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/generate-content#DynamicRetrievalConfig",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearchRetrieval.dynamicRetrievalConfig.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "MODE_UNSPECIFIED",
   "MODE_DYNAMIC"
  ],
  "description": "The mode of the predictor to be used in dynamic retrieval. MODE_UNSPECIFIED = always trigger retrieval; MODE_DYNAMIC = only when the predictor decides it is necessary.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/generate-content#Mode",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleSearchRetrieval.dynamicRetrievalConfig.dynamicThreshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "description": "The threshold to be used in dynamic retrieval. If not set, a system default value is used. Compared with groundingMetadata.retrievalMetadata.googleSearchDynamicRetrievalScore in [0,1].",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/generate-content#DynamicRetrievalConfig",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleMaps",
  "location": "body",
  "type": "object (GoogleMaps)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Tool that allows grounding the model's response with geospatial context related to the user's query. Empty object enables Grounding with Google Maps (off by default).",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#GoogleMaps",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].googleMaps.enableWidget",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Whether to return a widget context token in the GroundingMetadata of the response. Developers can use the widget context token to render a Google Maps widget with geospatial context related to the places that the model references in the response.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#GoogleMaps",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].urlContext",
  "location": "body",
  "type": "object (UrlContext, empty)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Tool to support URL context retrieval. No fields. URLs are taken from the prompt text (max 20 per request, 34 MB per URL).",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#UrlContext",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].codeExecution",
  "location": "body",
  "type": "object (CodeExecution, empty)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Enables the model to execute code as part of generation. No fields. Python-only sandbox, 30 s runtime.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#CodeExecution",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].computerUse",
  "location": "body",
  "type": "object (ComputerUse)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-computer-use-preview-10-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ComputerUse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].computerUse.environment",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "ENVIRONMENT_BROWSER (when UNSPECIFIED)",
  "minimum": null,
  "maximum": null,
  "enum": [
   "ENVIRONMENT_UNSPECIFIED",
   "ENVIRONMENT_BROWSER",
   "ENVIRONMENT_MOBILE",
   "ENVIRONMENT_DESKTOP"
  ],
  "description": "Required. The environment being operated. ENVIRONMENT_UNSPECIFIED defaults to browser. MOBILE and DESKTOP are Gemini 3.x only.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#Environment",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].computerUse.excludedPredefinedFunctions",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. Values are predefined action names (e.g. click, type, scroll, navigate; legacy: open_web_browser, click_at, type_text_at, scroll_document ...).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ComputerUse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].computerUse.enablePromptInjectionDetection",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Whether enable the prompt injection detection check on computer-use request. Opt-in; Gemini 3.5 Flash or later. Scans screenshots for hidden adversarial instructions and blocks execution when detected.",
  "compatible_models": [
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.6-flash",
   "gemini-3.7-flash",
   "gemini-3.8-flash"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ComputerUse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].computerUse.disabledSafetyPolicies",
  "location": "body",
  "type": "array<string (SafetyPolicy)>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "SAFETY_POLICY_UNSPECIFIED",
   "FINANCIAL_TRANSACTIONS",
   "SENSITIVE_DATA_MODIFICATION",
   "COMMUNICATION_TOOL",
   "ACCOUNT_CREATION",
   "DATA_MODIFICATION",
   "USER_CONSENT_MANAGEMENT",
   "LEGAL_TERMS_AND_AGREEMENTS"
  ],
  "description": "Optional. Disabled safety policies for computer use. Gemini 3.x. Overrides indicate preference; the model may still return safety_decision require_confirmation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#SafetyPolicy",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].fileSearch",
  "location": "body",
  "type": "object (FileSearch)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. FileSearch tool type. Tool to retrieve knowledge from Semantic Retrieval corpora.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash-lite",
   "gemini-2.5-flash"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#FileSearch",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].mcpServers",
  "location": "body",
  "type": "array<McpServer>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. MCP Servers to connect to. Present in discovery/REST reference; not covered by any generateContent guide (server-side MCP is documented for the Interactions API as type mcp_server). UNVERIFIED on the Gemini Developer API.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DOCUMENTATION_INCOMPLETE",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#McpServer",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].mcpServers[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the MCPServer.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#McpServer",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].mcpServers[].streamableHttpTransport",
  "location": "body",
  "type": "object (StreamableHttpTransport)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A transport that can stream HTTP requests and responses. Only transport in the union.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#StreamableHttpTransport",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].mcpServers[].streamableHttpTransport.url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The full URL for the MCPServer endpoint. Example: \"https://api.example.com/mcp\"",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#StreamableHttpTransport",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].mcpServers[].streamableHttpTransport.headers",
  "location": "body",
  "type": "object (map<string,string>)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional: Fields for authentication headers, timeouts, etc., if needed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#StreamableHttpTransport",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].mcpServers[].streamableHttpTransport.timeout",
  "location": "body",
  "type": "string (duration, e.g. '3.5s')",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "HTTP timeout for regular operations.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#StreamableHttpTransport",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].mcpServers[].streamableHttpTransport.sseReadTimeout",
  "location": "body",
  "type": "string (duration)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Timeout for SSE read operations.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#StreamableHttpTransport",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "tools[].mcpServers[].streamableHttpTransport.terminateOnClose",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to close the client session when the transport closes.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/api/generate-content#StreamableHttpTransport",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig",
  "location": "body",
  "type": "object (ToolConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Tool configuration for any Tool specified in the request: functionCallingConfig, retrievalConfig, includeServerSideToolInvocations.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolConfig",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig.functionCallingConfig",
  "location": "body",
  "type": "object (FunctionCallingConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Function calling config.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionCallingConfig",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig.functionCallingConfig.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "AUTO (VALIDATED in tool-combination requests)",
  "minimum": null,
  "maximum": null,
  "enum": [
   "MODE_UNSPECIFIED",
   "AUTO",
   "ANY",
   "NONE",
   "VALIDATED"
  ],
  "description": "Optional. Specifies the mode in which function calling should execute. If unspecified, the default value will be set to AUTO. AUTO: model chooses call or text. ANY: always a (schema-constrained) function call. NONE: never call. VALIDATED: call or text with constrained-decoding validation; default (and only allowed mode) when built-in tools/structured outputs are combined or includeServerSideToolInvocations=true. ANY may reject very large/deeply nested schemas.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionCallingConfig",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig.functionCallingConfig.allowedFunctionNames",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. A set of function names that, when provided, limits the functions the model will call. This should only be set when the Mode is ANY or VALIDATED. Function names should match [FunctionDeclaration.name]. When set, model will predict a function call from only allowed function names.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionCallingConfig",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig.retrievalConfig",
  "location": "body",
  "type": "object (RetrievalConfig)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Retrieval config. Used by Grounding with Google Maps (user location) and search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#RetrievalConfig",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig.retrievalConfig.latLng",
  "location": "body",
  "type": "object (LatLng)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The location of the user. WGS84 degrees.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#LatLng",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig.retrievalConfig.latLng.latitude",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": -90,
  "maximum": 90,
  "enum": null,
  "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#LatLng",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig.retrievalConfig.latLng.longitude",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": -180,
  "maximum": 180,
  "enum": null,
  "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#LatLng",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig.retrievalConfig.languageCode",
  "location": "body",
  "type": "string (BCP-47)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The language code of the user. Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#RetrievalConfig",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "toolConfig.includeServerSideToolInvocations",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. If true, the API response will include the server-side tool calls and responses within the `Content` message. This allows clients to observe the server's tool interactions. Enables Gemini 3 'tool context circulation': toolCall/toolResponse parts are returned and must be echoed back with their id, toolType and thoughtSignature. Forces VALIDATED function-calling mode (AUTO unsupported). Preview, Gemini 3 only.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/tool-combination",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionCall",
  "location": "body",
  "type": "object (FunctionCall)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model-generated part (echo it back verbatim in history). A predicted `FunctionCall` returned from the model that contains a string representing the `FunctionDeclaration.name` with the arguments and their values.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionCall",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionCall.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The name of the function to call. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 128.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionCall",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionCall.args",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The function parameters and values in JSON object format.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionCall",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionCall.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Unique identifier of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. Gemini 3 always returns an id; you must echo it in functionResponse.id.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionCall",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionResponse",
  "location": "body",
  "type": "object (FunctionResponse)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Client-provided result of a functionCall, sent in the next content (role user or function). The result output from a `FunctionCall` that contains a string representing the `FunctionDeclaration.name` and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a`FunctionCall` made based on model prediction.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionResponse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionResponse.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The name of the function to call. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 128.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionResponse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionResponse.response",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The function response in JSON object format. Callers can use any keys of their choice that fit the function's syntax to return the function output, e.g. \"output\", \"result\", etc. In particular, if the function call failed to execute, the response can have an \"error\" key to return error details to the model. Multimedia can be included by using a subobject containing a single \"$ref\" key whose value is the `inline_data.display_name` of a `FunctionResponsePart` holding the multimedia. See https://ai.google.dev/gemini-api/docs/function-calling#multimodal.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionResponse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionResponse.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The identifier of the function call this response is for. Populated by the client to match the corresponding function call `id`. Mandatory mapping on Gemini 3.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionResponse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionResponse.parts",
  "location": "body",
  "type": "array<FunctionResponsePart>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. Gemini 3 multimodal function responses: image/png, image/jpeg, image/webp, application/pdf, text/plain.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionResponsePart",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionResponse.parts[].inlineData",
  "location": "body",
  "type": "object (FunctionResponseBlob)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline media bytes. Only member of the data union.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionResponseBlob",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionResponse.parts[].inlineData.mimeType",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The IANA standard MIME type of the source data. Examples: - image/png - image/jpeg If an unsupported MIME type is provided, an error will be returned. For a complete list of supported types, see [Supported file formats](https://ai.google.dev/gemini-api/docs/prompting_with_media#supported_file_formats).",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionResponseBlob",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].functionResponse.parts[].inlineData.data",
  "location": "body",
  "type": "string (base64)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Raw bytes for media formats.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionResponseBlob",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent (toolResponse.functionResponses[]) — ignored by generateContent",
  "parameter": "contents[].parts[].functionResponse.scheduling",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "WHEN_IDLE",
  "minimum": null,
  "maximum": null,
  "enum": [
   "SCHEDULING_UNSPECIFIED",
   "SILENT",
   "WHEN_IDLE",
   "INTERRUPT"
  ],
  "description": "Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-2.5-flash-native-audio-preview-12-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#Scheduling",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "WSS BidiGenerateContent (toolResponse.functionResponses[]) — ignored by generateContent",
  "parameter": "contents[].parts[].functionResponse.willContinue",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished. This may still trigger the model generation. To avoid triggering the generation and finish the function call, additionally set `scheduling` to `SILENT`.",
  "compatible_models": [
   "gemini-3.8-live",
   "gemini-2.5-flash-native-audio-preview-12-2025"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#FunctionResponse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].thoughtSignature",
  "location": "body",
  "type": "string (base64)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. An opaque signature for the thought so it can be reused in subsequent requests. Gemini 3: mandatory on the first functionCall part of every step of the current turn (400 'Function call X in the N. content block is missing a thought_signature' otherwise); recommended on other parts. Gemini 2.5: optional. Dummy values 'skip_thought_signature_validator' / 'context_engineering_is_the_way_to_go' bypass validation for injected history. Do not merge/split parts carrying signatures.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview",
   "gemini-2.5-pro",
   "gemini-2.5-flash",
   "gemini-2.5-flash-lite"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/generate-content/thought-signatures",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].executableCode",
  "location": "body",
  "type": "object (ExecutableCode)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model-generated (codeExecution tool) — echo back in multi-turn history with id and thoughtSignature. Code generated by the model that is meant to be executed, and the result returned to the model. Only generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding `CodeExecutionResult` will also be generated.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#ExecutableCode",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].executableCode.language",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "LANGUAGE_UNSPECIFIED",
   "PYTHON"
  ],
  "description": "Required. Programming language of the `code`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#Language",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].executableCode.code",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required. The code to be executed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#ExecutableCode",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].executableCode.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#ExecutableCode",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].codeExecutionResult",
  "location": "body",
  "type": "object (CodeExecutionResult)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Server-generated result of executableCode — echo back in history. Result of executing the `ExecutableCode`. Generated only when the `CodeExecution` tool is used.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#CodeExecutionResult",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].codeExecutionResult.outcome",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "OUTCOME_UNSPECIFIED",
   "OUTCOME_OK",
   "OUTCOME_FAILED",
   "OUTCOME_DEADLINE_EXCEEDED"
  ],
  "description": "Required. Outcome of the code execution.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#Outcome",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].codeExecutionResult.output",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#CodeExecutionResult",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].codeExecutionResult.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/api/generate-content#CodeExecutionResult",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolCall",
  "location": "body",
  "type": "object (ToolCall)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Server-side tool call returned when toolConfig.includeServerSideToolInvocations=true (Gemini 3 tool combination). A predicted server-side `ToolCall` returned from the model. This message contains information about a tool that the model wants to invoke. The client is NOT expected to execute this `ToolCall`. Instead, the client should pass this `ToolCall` back to the API in a subsequent turn within a `Content` message, along with the corresponding `ToolResponse`.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolCall",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolCall.toolType",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "TOOL_TYPE_UNSPECIFIED",
   "GOOGLE_SEARCH_WEB",
   "GOOGLE_SEARCH_IMAGE",
   "URL_CONTEXT",
   "GOOGLE_MAPS",
   "FILE_SEARCH"
  ],
  "description": "Required. The type of tool that was called.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolType",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolCall.args",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The tool call arguments. Example: {\"arg1\" : \"value1\", \"arg2\" : \"value2\" , ...} User-visible args: GOOGLE_SEARCH queries[], GOOGLE_MAPS queries[], URL_CONTEXT urls[], FILE_SEARCH none.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolCall",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolCall.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. Unique identifier of the tool call. The server returns the tool response with the matching `id`.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolCall",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolCall.toolName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The name of the tool that was called.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolCall",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolResponse",
  "location": "body",
  "type": "object (ToolResponse)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Server-side tool result echoed with the toolCall. The output from a server-side `ToolCall` execution. This message contains the results of a tool invocation that was initiated by a `ToolCall` from the model. The client should pass this `ToolResponse` back to the API in a subsequent turn within a `Content` message, along with the corresponding `ToolCall`.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolResponse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolResponse.toolType",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "TOOL_TYPE_UNSPECIFIED",
   "GOOGLE_SEARCH_WEB",
   "GOOGLE_SEARCH_IMAGE",
   "URL_CONTEXT",
   "GOOGLE_MAPS",
   "FILE_SEARCH"
  ],
  "description": "Required. The type of tool that was called, matching the `tool_type` in the corresponding `ToolCall`.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolType",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolResponse.response",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The tool response. User-visible: GOOGLE_SEARCH search_suggestions; GOOGLE_MAPS places, google_maps_widget_context_token; URL_CONTEXT urls_metadata[{retrieved_url,url_retrieval_status}].",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolResponse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:generateContent",
  "parameter": "contents[].parts[].toolResponse.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional. The identifier of the tool call this response is for.",
  "compatible_models": [
   "gemini-3.8-flash",
   "gemini-3.7-flash",
   "gemini-3.6-flash",
   "gemini-3.5-flash",
   "gemini-3.5-flash-lite",
   "gemini-3.1-pro-preview",
   "gemini-3.1-flash-lite",
   "gemini-3-flash-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://ai.google.dev/api/generate-content#ToolResponse",
  "_fragment": "generated/fragments/parameters/gemini-tools.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "tunedModelId",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional id, <= 40 chars, regex [a-z]([a-z0-9-]{0,38}[a-z0-9])?",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning#method:-tunedmodels.create",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "displayName",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 40,
  "enum": null,
  "description": "<= 40 chars; used to derive the resource id (tunedModels/sentence-translator-u3b7m).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Short description.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "baseModel",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Immutable. Model to tune, e.g. models/gemini-1.5-flash-001. No base model currently supports tuning in the Gemini API (Gemini 1.5 Flash-001 deprecated May 2025).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/model-tuning",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "tunedModelSource.tunedModel",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Immutable. Existing tunedModels/… to start from (alternative to baseModel).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning#TunedModelSource",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "tuningTask.trainingData.examples.examples[]",
  "location": "body",
  "type": "array<{textInput, output}>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline text examples (required); all examples in a set must be the same type.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning#TuningExample",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "tuningTask.hyperparameters.epochCount",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 5,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Immutable; default 5.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning#Hyperparameters",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "tuningTask.hyperparameters.batchSize",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Immutable; default 4 or 16 depending on dataset size.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning#Hyperparameters",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "tuningTask.hyperparameters.learningRate",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Immutable; default 0.001 or 0.0002 by dataset size. Mutually exclusive with learningRateMultiplier.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning#Hyperparameters",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "tuningTask.hyperparameters.learningRateMultiplier",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1.0,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Immutable; actual lr = multiplier x default (default 1.0).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning#Hyperparameters",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0.0,
  "maximum": 1.0,
  "enum": null,
  "description": "Default sampling temperature of the tuned model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "topP",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default nucleus sampling.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "topK",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default top-k.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/tunedModels",
  "parameter": "readerProjectNumbers[]",
  "location": "body",
  "type": "array<string (int64)>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Projects with read access.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/tunedModels",
  "parameter": "pageSize",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 10,
  "minimum": null,
  "maximum": 1000,
  "enum": null,
  "description": "Default 10, max 1000 per page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://ai.google.dev/api/tuning#method:-tunedmodels.list",
  "notes": "Live 2026-09-18: GET /v1beta/tunedModels?pageSize=5 -> HTTP 501 UNIMPLEMENTED: Operation is not implemented, or supported, or enabled.",
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/tunedModels",
  "parameter": "pageToken",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pagination token.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/tunedModels",
  "parameter": "filter",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full-text search over description/displayName; operators owner:me, writers:me, readers:me, readers:everyone.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "PATCH /v1beta/{tunedModel.name=tunedModels/*}",
  "parameter": "updateMask",
  "location": "query",
  "type": "string (FieldMask)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Fields to update (displayName, description, …).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning#method:-tunedmodels.patch",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/{name=tunedModels/*}:transferOwnership",
  "parameter": "emailAddress",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New owner's e-mail; only way to change the owner.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/{parent=tunedModels/*}/permissions",
  "parameter": "granteeType",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "USER",
   "GROUP",
   "EVERYONE"
  ],
  "description": "USER | GROUP | EVERYONE (immutable).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/{parent=tunedModels/*}/permissions",
  "parameter": "emailAddress",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User/group e-mail (not set for EVERYONE).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/{parent=tunedModels/*}/permissions",
  "parameter": "role",
  "location": "body",
  "type": "enum",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "OWNER",
   "WRITER",
   "READER"
  ],
  "description": "OWNER | WRITER | READER (required).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/{model=tunedModels/*}:generateContent",
  "parameter": "contents[]",
  "location": "body",
  "type": "array<Content>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Same body as models.generateContent; the tuned model is addressed as tunedModels/{id}.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://ai.google.dev/api/tuning#method:-tunedmodels.generatecontent",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-tuning.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "instances[].prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text description (<= 1,024 tokens). Supports audio cues: quoted dialogue, SFX, ambient noise. Optional if image or video is provided (SDK).",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview",
   "veo-3.0-generate-001",
   "veo-3.0-fast-generate-001",
   "veo-2.0-generate-001"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#veo-api-parameters-and-specifications",
  "notes": "Live: empty body -> HTTP 400 INVALID_ARGUMENT: No instances in the request. | instances:[{}] -> HTTP 400 INVALID_ARGUMENT: Unsupported video generation request. Please check the documentation for supported usage: https://ai.google.dev/gemini-api/docs/video",
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "instances[].image",
  "location": "body",
  "type": "object Image {inlineData{mimeType,data}}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Initial frame for image-to-video. Not allowed together with `video`.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview",
   "veo-3.0-generate-001",
   "veo-3.0-fast-generate-001",
   "veo-2.0-generate-001"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#image-to-video-generation",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "instances[].lastFrame",
  "location": "body",
  "type": "object Image",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Final frame for interpolation; must be combined with `image`. Veo 3.1 family.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#using-first-and-last-frames",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "instances[].referenceImages[]",
  "location": "body",
  "type": "array<{image: Image, referenceType}>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 3,
  "enum": null,
  "description": "Up to 3 reference images (subject/product/character consistency). Not on Veo 3.1 Lite. durationSeconds must be 8. personGeneration allow_adult only.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#using-reference-images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "instances[].referenceImages[].referenceType",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asset",
   "style"
  ],
  "description": "asset = object/character/scene to include; style = aesthetics (SDK enum ASSET|STYLE). Docs samples use lowercase 'asset'.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "instances[].video",
  "location": "body",
  "type": "object Video {inlineData{mimeType:'video/mp4',data}} or {uri}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Veo-generated video to extend (+7 s per call, up to 20 times, input <= 141 s, output <= 148 s, 720p, 9:16 or 16:9, generated/referenced within the last 2 days). Veo 3.1 and 3.1 Fast only.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#extending-veo-videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.aspectRatio",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "16:9",
  "minimum": null,
  "maximum": null,
  "enum": [
   "16:9",
   "9:16"
  ],
  "description": "Landscape or portrait.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview",
   "veo-3.0-generate-001",
   "veo-3.0-fast-generate-001",
   "veo-2.0-generate-001"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#control-the-aspect-ratio",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.durationSeconds",
  "location": "body",
  "type": "string|integer",
  "required": false,
  "default": "8",
  "minimum": null,
  "maximum": null,
  "enum": [
   "4",
   "6",
   "8"
  ],
  "description": "Clip length. Must be \"8\" with extension, reference images, 1080p or 4k.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#veo-api-parameters-and-specifications",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.resolution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "720p",
  "minimum": null,
  "maximum": null,
  "enum": [
   "720p",
   "1080p",
   "4k"
  ],
  "description": "Output resolution. 1080p and 4k require 8 s; 4k not on Veo 3.1 Lite; extension is 720p only. Higher resolution = higher latency and price.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#control-the-resolution",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.personGeneration",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "allow_all",
   "allow_adult",
   "dont_allow"
  ],
  "description": "Text-to-video and extension: allow_all only; image-to-video, interpolation, reference images: allow_adult only. EU/UK/CH/MENA: allow_adult only.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview",
   "veo-3.0-generate-001",
   "veo-3.0-fast-generate-001",
   "veo-2.0-generate-001"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#limitations",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.negativePrompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "What to exclude from the video (SDK GenerateVideosConfig.negative_prompt).",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.seed",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "RNG seed; improves but does not guarantee determinism.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview",
   "veo-3.0-generate-001",
   "veo-3.0-fast-generate-001",
   "veo-2.0-generate-001"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#veo-api-parameters-and-specifications",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.numberOfVideos",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 1,
  "minimum": 1,
  "maximum": 1,
  "enum": null,
  "description": "Videos per request (Gemini API: 1).",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#extending-veo-videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.generateAudio",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK field; Veo 3.x always generates audio (always on).",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.enhancePrompt",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK field: prompt rewriting.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.fps",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 24,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK field; output is 24 fps.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.compressionQuality",
  "location": "body",
  "type": "enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "OPTIMIZED",
   "LOSSLESS"
  ],
  "description": "SDK VideoCompressionQuality (OPTIMIZED|LOSSLESS).",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://github.com/googleapis/python-genai/blob/main/google/genai/types.py",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "parameters.webhookConfig.uris[]",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SDK: webhook URIs notified when the operation completes (Webhooks feature).",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/webhooks",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "POST /v1beta/models/{model}:predictLongRunning",
  "parameter": "labels",
  "location": "body",
  "type": "object<string,string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-defined labels for billing tracking (PredictLongRunningRequest.labels).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://generativelanguage.googleapis.com/$discovery/rest?version=v1beta",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET /v1beta/{name=models/*/operations/*}",
  "parameter": "name",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Operation name returned by predictLongRunning, e.g. models/veo-3.1-generate-preview/operations/abc123. Poll until done=true (latency 11 s to 6 min).",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#handling-asynchronous-operations",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "gemini",
  "endpoint": "GET {response.generateVideoResponse.generatedSamples[].video.uri}",
  "parameter": "x-goog-api-key",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Download the generated MP4: GET the returned uri (https://generativelanguage.googleapis.com/v1beta/files/<id>:download?alt=media) with the API key header and follow redirects (-L). Stored 2 days.",
  "compatible_models": [
   "veo-3.1-generate-preview",
   "veo-3.1-fast-generate-preview",
   "veo-3.1-lite-generate-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://ai.google.dev/gemini-api/docs/veo#text-to-video-generation",
  "notes": null,
  "_fragment": "generated/fragments/parameters/gemini-video-generation.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/admin_api_keys",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/admin_api_keys",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/admin_api_keys",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/admin_api_keys",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/admin_api_keys",
  "parameter": "expires_in_seconds",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 31536000,
  "enum": null,
  "description": "The number of seconds until the API key expires. Omit this field for a key that does not expire.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/admin_api_keys/{key_id}",
  "parameter": "key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/admin_api_keys/{key_id}",
  "parameter": "key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "effective_at",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only events whose `effective_at` (Unix seconds) is in this range.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "project_ids[]",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only events for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "event_types[]",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "api_key.created",
   "api_key.updated",
   "api_key.deleted",
   "certificate.created",
   "certificate.updated",
   "certificate.deleted",
   "certificates.activated",
   "certificates.deactivated",
   "checkpoint.permission.created",
   "checkpoint.permission.deleted",
   "external_key.registered",
   "external_key.removed",
   "external_storage.registered",
   "external_storage.removed",
   "group.created",
   "group.updated",
   "group.deleted",
   "invite.sent",
   "invite.accepted",
   "invite.deleted",
   "ip_allowlist.created",
   "ip_allowlist.updated",
   "ip_allowlist.deleted",
   "ip_allowlist.config.activated",
   "ip_allowlist.config.deactivated",
   "login.succeeded",
   "login.failed",
   "logout.succeeded",
   "logout.failed",
   "organization.updated",
   "project.created",
   "project.updated",
   "project.archived",
   "project.deleted",
   "rate_limit.updated",
   "rate_limit.deleted",
   "resource.deleted",
   "tunnel.created",
   "tunnel.updated",
   "tunnel.deleted",
   "workload_identity_provider.created",
   "workload_identity_provider.updated",
   "workload_identity_provider.deleted",
   "workload_identity_provider_mapping.created",
   "workload_identity_provider_mapping.updated",
   "workload_identity_provider_mapping.deleted",
   "role.created",
   "role.updated",
   "role.deleted",
   "role.assignment.created",
   "role.assignment.deleted",
   "role.bound_to_resource",
   "role.unbound_from_resource",
   "scim.enabled",
   "scim.disabled",
   "service_account.created",
   "service_account.updated",
   "service_account.deleted",
   "user.added",
   "user.updated",
   "user.deleted",
   "tenant.metadata.updated",
   "tenant.microsoft_entra_mapping.upserted",
   "tenant.microsoft_entra_mapping.deleted",
   "tenant.workload_identity.provider.created",
   "tenant.workload_identity.provider.updated",
   "tenant.workload_identity.provider.archived",
   "tenant.workload_identity.mapping.created",
   "tenant.workload_identity.mapping.updated",
   "tenant.workload_identity.mapping.archived",
   "tenant.workload_identity.binding.created",
   "tenant.workload_identity.principal.provisioned",
   "tenant.workload_identity.access_token.issued",
   "tenant.admin_api_key.created",
   "tenant.admin_api_key.updated",
   "tenant.admin_api_key.deleted",
   "tenant.project_api_key.created",
   "tenant.trusted_access.business_verification.started",
   "tenant.trusted_access.application.submitted",
   "tenant.chatgpt_access_token.revoked",
   "tenant.migration.completed",
   "tenant.sso.migrated",
   "tenant.domains.migrated",
   "tenant.sso_connection.created",
   "tenant.sso_connection.updated",
   "tenant.sso_connection.deleted",
   "tenant.sso_connection.setup.started",
   "tenant.policy.created",
   "tenant.policy.updated",
   "tenant.policy.deleted",
   "tenant.policy.attached",
   "tenant.policy.detached",
   "tenant.principal_authentication_policy.resolved",
   "tenant.scim.setup.started",
   "tenant.scim.deletion.requested",
   "tenant.scim.directory.created",
   "tenant.product_access_policy.updated",
   "tenant.resource_share_grant.created",
   "tenant.resource_share_grant.updated",
   "tenant.resource_share_grant.accepted",
   "tenant.resource_share_grant.declined",
   "tenant.resource_share_grant.revoked",
   "tenant.resource_share_grant.deleted",
   "tenant.service_account.updated",
   "tenant.service_account.deleted",
   "tenant.service_account.token.revoked",
   "tenant.billing.overage_limit.updated",
   "tenant.billing.alerts.updated",
   "tenant.billing.info.updated",
   "tenant.usage_limit.workspace.updated",
   "tenant.usage_limit.group.updated",
   "tenant.usage_limit.user.updated",
   "tenant.usage_limit.increase_request.updated",
   "tenant.usage_limit.increase_request.resolved",
   "tenant.group.created",
   "tenant.group.updated",
   "tenant.group.deleted",
   "tenant.group.member.added",
   "tenant.group.member.removed",
   "tenant.migration_rollout.status.updated",
   "tenant.migration_rollout.tier.updated",
   "tenant.role.metadata.updated",
   "tenant.custom_role.created",
   "tenant.custom_role.updated",
   "tenant.custom_role.deleted",
   "tenant.role_assignment.created",
   "tenant.role_assignment.deleted",
   "tenant.resource_role_assignment.created",
   "tenant.resource_role_assignment.deleted",
   "tenant.resource_access.updated",
   "tenant.resource_access.deleted",
   "tenant.ads_account.onboarding.redemption",
   "tenant.session_policy.created",
   "tenant.session_policy.updated",
   "tenant.session_policy.deleted",
   "tenant.session_revocation.started",
   "tenant.third_party_app_policy.updated",
   "tenant.user.added",
   "tenant.user.updated",
   "tenant.user.removed",
   "tenant.user.looked_up",
   "tenant.user.invited",
   "tenant.membership.revoked",
   "tenant.api_organization_invite.upserted",
   "tenant.api_organization_invite.deleted",
   "tenant.chatgpt_workspace_invite.upserted",
   "tenant.membership.accepted",
   "tenant.membership.declined",
   "tenant.workspace_invite_email_settings.updated"
  ],
  "description": "Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "actor_ids[]",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "actor_emails[]",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only events performed by users with these emails.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "resource_ids[]",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only events performed on these targets. For example, a project ID updated. For ChatGPT connector role events, use the workspace connector resource ID shown in `details.id`, such as `<workspace_id>__<connector_id>`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "tenant_only",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only tenant-scoped events associated with this organization. Required for tenant-scoped events such as `role.bound_to_resource` and `role.unbound_from_resource`. When `true`, all supplied event types must be tenant-scoped.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/audit_logs",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/certificates",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/certificates",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/certificates",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/certificates",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional name for the certificate",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/certificates",
  "parameter": "certificate",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The certificate content in PEM format",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/certificates/activate",
  "parameter": "certificate_ids",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/certificates/deactivate",
  "parameter": "certificate_ids",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/certificates/{certificate_id}",
  "parameter": "certificate_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique ID of the certificate to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/certificates/{certificate_id}",
  "parameter": "include",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "content"
  ],
  "description": "A list of additional fields to include in the response. Currently the only supported value is `content` to fetch the PEM content of the certificate.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/certificates/{certificate_id}",
  "parameter": "certificate_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique ID of the certificate to modify.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/certificates/{certificate_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The updated name for the certificate",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/certificates/{certificate_id}",
  "parameter": "certificate_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique ID of the certificate to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/costs",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/costs",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/costs",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently only `1d` is supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/costs",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only costs for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/costs",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only costs for these API keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/costs",
  "parameter": "line_items",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only costs for these exact line item names. Each value must match the complete `line_item` value, for example `gpt-6-astra, input_tokens`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/costs",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id",
   "line_item",
   "api_key_id"
  ],
  "description": "Group the costs by the specified fields. Support fields include `project_id`, `line_item`, `api_key_id` and any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/costs",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 7,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/costs",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/data_retention",
  "parameter": "retention_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "zero_data_retention",
   "modified_abuse_monitoring",
   "enhanced_zero_data_retention",
   "enhanced_modified_abuse_monitoring"
  ],
  "description": "The desired organization data retention type.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 100,
  "minimum": 0,
  "maximum": 1000,
  "enum": null,
  "description": "A limit on the number of groups to be returned. Limit can range between 0 and 1000, and the default is 100.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is a group ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with group_abc, your subsequent call can include `after=group_abc` in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Specifies the sort order of the returned groups.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/groups",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 255,
  "enum": null,
  "description": "Human readable name for the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/groups/{group_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/groups/{group_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 255,
  "enum": null,
  "description": "New display name for the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/groups/{group_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/roles",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group whose organization role assignments you want to list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/roles",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1000,
  "enum": null,
  "description": "A limit on the number of organization role assignments to return.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/roles",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the value from the previous response's `next` field to continue listing organization roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/roles",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for the returned organization roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/groups/{group_id}/roles",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group that should receive the organization role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/groups/{group_id}/roles",
  "parameter": "role_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the role to assign.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/roles/{role_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the organization role to retrieve for the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/groups/{group_id}/roles/{role_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to modify.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/groups/{group_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the organization role to remove from the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/users",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/users",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 100,
  "minimum": 0,
  "maximum": 1000,
  "enum": null,
  "description": "A limit on the number of users to be returned. Limit can range between 0 and 1000, and the default is 100.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/users",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Provide the ID of the last user from the previous list response to retrieve the next page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/users",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Specifies the sort order of users in the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/groups/{group_id}/users",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/groups/{group_id}/users",
  "parameter": "user_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the user to add to the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/users/{user_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/groups/{group_id}/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user to retrieve from the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/groups/{group_id}/users/{user_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/groups/{group_id}/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user to remove from the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/invites",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/invites",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/invites",
  "parameter": "email",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Send an email to this address",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/invites",
  "parameter": "role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "reader",
   "owner"
  ],
  "description": "`owner` or `reader`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/invites",
  "parameter": "projects",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior. If empty list is passed, the user will not be invited to any projects, including the default one.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/invites",
  "parameter": "projects[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Project's public ID",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/invites",
  "parameter": "projects[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "member",
   "owner"
  ],
  "description": "Project membership role",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/invites/{invite_id}",
  "parameter": "invite_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the invite to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/invites/{invite_id}",
  "parameter": "invite_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the invite to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects",
  "parameter": "include_archived",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If `true` returns all projects including those that have been `archived`. Archived projects are not included by default.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The friendly name of the project, this name appears in reports.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects",
  "parameter": "geography",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. Deprecated: use `residency` instead. Do not provide both `geography` and `residency`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects",
  "parameter": "residency",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "GLOBAL",
   "US_STORAGE_PROCESSING",
   "EU_STORAGE_PROCESSING",
   "JP_STORAGE",
   "KR_STORAGE",
   "CA_STORAGE",
   "SG_STORAGE",
   "IN_STORAGE",
   "AU_STORAGE",
   "GB_STORAGE",
   "AE_STORAGE",
   "AE_STORAGE_PROCESSING"
  ],
  "description": "Create the project with the specified residency configuration. Your organization must have access to the requested residency configuration in order to use it. See [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects",
  "parameter": "external_key_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "External key ID to associate with the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}",
  "parameter": "name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The updated name of the project, this name appears in reports.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}",
  "parameter": "external_key_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "External key ID to associate with the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}",
  "parameter": "geography",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Geography for the project. Deprecated: use `residency` when creating a project to configure data residency. This field is retained for backward compatibility.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/api_keys",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/api_keys",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/api_keys",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/api_keys",
  "parameter": "owner_project_access",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "active",
   "inactive",
   "any"
  ],
  "description": "Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/api_keys/{api_key_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/api_keys/{api_key_id}",
  "parameter": "api_key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the API key.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/api_keys/{api_key_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/api_keys/{api_key_id}",
  "parameter": "api_key_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the API key.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/archive",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/certificates",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/certificates",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/certificates",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/certificates",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/certificates/activate",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/certificates/activate",
  "parameter": "certificate_ids",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/certificates/deactivate",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/certificates/deactivate",
  "parameter": "certificate_ids",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/data_retention",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/data_retention",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/data_retention",
  "parameter": "retention_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "organization_default",
   "none",
   "zero_data_retention",
   "modified_abuse_monitoring",
   "enhanced_zero_data_retention",
   "enhanced_modified_abuse_monitoring"
  ],
  "description": "The desired project data retention type.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/groups",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/groups",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "A limit on the number of project groups to return. Defaults to 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/groups",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the ID of the last group from the previous response to fetch the next page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/groups",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for the returned groups.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/groups",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/groups",
  "parameter": "group_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the group to add to the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/groups",
  "parameter": "role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the project role to grant to the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/groups/{group_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/groups/{group_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/groups/{group_id}",
  "parameter": "group_type",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "group",
  "minimum": null,
  "maximum": null,
  "enum": [
   "group",
   "tenant_group"
  ],
  "description": "The type of group to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/groups/{group_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/groups/{group_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to remove from the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "file_search",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file search permission update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "file_search.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable the hosted tool for the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "web_search",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The web search permission update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "web_search.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable the hosted tool for the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "image_generation",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image generation permission update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "image_generation.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable the hosted tool for the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "mcp",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The MCP permission update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "mcp.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable the hosted tool for the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "code_interpreter",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The code interpreter permission update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/hosted_tool_permissions",
  "parameter": "code_interpreter.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable the hosted tool for the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/model_permissions",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/model_permissions",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/model_permissions",
  "parameter": "mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "allow_list",
   "deny_list"
  ],
  "description": "The model permissions mode to apply.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/model_permissions",
  "parameter": "model_ids",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model IDs included in this permissions policy.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/model_permissions",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/rate_limits",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/rate_limits",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 100,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. The default is 100.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/rate_limits",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/rate_limits",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, beginning with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}",
  "parameter": "rate_limit_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the rate limit.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}",
  "parameter": "max_requests_per_1_minute",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum requests per minute.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}",
  "parameter": "max_tokens_per_1_minute",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum tokens per minute.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}",
  "parameter": "max_images_per_1_minute",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum images per minute. Only relevant for certain models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}",
  "parameter": "max_audio_megabytes_per_1_minute",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum audio megabytes per minute. Only relevant for certain models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}",
  "parameter": "max_requests_per_1_day",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum requests per day. Only relevant for certain models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/rate_limits/{rate_limit_id}",
  "parameter": "batch_1_day_max_input_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum batch input tokens per day. Only relevant for certain models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/service_accounts",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/service_accounts",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/service_accounts",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the service account being created.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts",
  "parameter": "create_service_account_only",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts",
  "parameter": "expires_in_seconds",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of seconds until the initial API key expires. If omitted or null, the key does not expire unless the effective organization or project policy requires an expiration. When a policy sets a maximum lifetime, this value must be provided and must not exceed that limit. A non-null value cannot be used when `create_service_account_only` is true.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/service_accounts/{service_account_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/service_accounts/{service_account_id}",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the service account.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts/{service_account_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts/{service_account_id}",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the service account.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts/{service_account_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The updated service account name.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts/{service_account_id}",
  "parameter": "role",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "member",
   "owner"
  ],
  "description": "The updated service account role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/service_accounts/{service_account_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/service_accounts/{service_account_id}",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the service account.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "A limit on the number of spend alerts to return. Defaults to 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for the returned spend alerts.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the ID of the last spend alert from the previous response to fetch the next page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the ID of the first spend alert from the previous response to fetch the previous page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "threshold_amount",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "The alert threshold amount, in cents.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "currency",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "USD"
  ],
  "description": "The currency for the threshold amount.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "interval",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "month"
  ],
  "description": "The time interval for evaluating spend against the threshold.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "notification_channel",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email notification settings for a spend alert.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "notification_channel.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "email"
  ],
  "description": "The notification channel type. Currently only `email` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "notification_channel.recipients",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email addresses that receive the spend alert notification.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts",
  "parameter": "notification_channel.subject_prefix",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional subject prefix for alert emails.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "alert_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the spend alert to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "alert_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the spend alert to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "threshold_amount",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "The alert threshold amount, in cents.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "currency",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "USD"
  ],
  "description": "The currency for the threshold amount.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "interval",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "month"
  ],
  "description": "The time interval for evaluating spend against the threshold.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "notification_channel",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email notification settings for a spend alert.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "notification_channel.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "email"
  ],
  "description": "The notification channel type. Currently only `email` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "notification_channel.recipients",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email addresses that receive the spend alert notification.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "notification_channel.subject_prefix",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional subject prefix for alert emails.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/spend_alerts/{alert_id}",
  "parameter": "alert_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the spend alert to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/users",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/users",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/users",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/users",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/users",
  "parameter": "user_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/users",
  "parameter": "email",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email of the user to add.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/users",
  "parameter": "role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`owner` or `member`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/users/{user_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/users/{user_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/users/{user_id}",
  "parameter": "role",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`owner` or `member`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/users/{user_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/roles",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 1000,
  "minimum": 0,
  "maximum": 1000,
  "enum": null,
  "description": "A limit on the number of roles to return. Defaults to 1000.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/roles",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the value from the previous response's `next` field to continue listing roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/roles",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for the returned roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/roles",
  "parameter": "role_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/roles",
  "parameter": "permissions",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permissions to grant to the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/roles",
  "parameter": "description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional description of the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the role to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the role to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/roles/{role_id}",
  "parameter": "permissions",
  "location": "body",
  "type": "array<string> | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated set of permissions for the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/roles/{role_id}",
  "parameter": "description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New description for the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/roles/{role_id}",
  "parameter": "role_name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New name for the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the role to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/spend_alerts",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "A limit on the number of spend alerts to return. Defaults to 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/spend_alerts",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for the returned spend alerts.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/spend_alerts",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the ID of the last spend alert from the previous response to fetch the next page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/spend_alerts",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the ID of the first spend alert from the previous response to fetch the previous page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts",
  "parameter": "threshold_amount",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "The alert threshold amount, in cents.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts",
  "parameter": "currency",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "USD"
  ],
  "description": "The currency for the threshold amount.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts",
  "parameter": "interval",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "month"
  ],
  "description": "The time interval for evaluating spend against the threshold.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts",
  "parameter": "notification_channel",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email notification settings for a spend alert.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts",
  "parameter": "notification_channel.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "email"
  ],
  "description": "The notification channel type. Currently only `email` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts",
  "parameter": "notification_channel.recipients",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email addresses that receive the spend alert notification.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts",
  "parameter": "notification_channel.subject_prefix",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional subject prefix for alert emails.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/spend_alerts/{alert_id}",
  "parameter": "alert_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the spend alert to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts/{alert_id}",
  "parameter": "alert_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the spend alert to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts/{alert_id}",
  "parameter": "threshold_amount",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "The alert threshold amount, in cents.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts/{alert_id}",
  "parameter": "currency",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "USD"
  ],
  "description": "The currency for the threshold amount.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts/{alert_id}",
  "parameter": "interval",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "month"
  ],
  "description": "The time interval for evaluating spend against the threshold.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts/{alert_id}",
  "parameter": "notification_channel",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email notification settings for a spend alert.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts/{alert_id}",
  "parameter": "notification_channel.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "email"
  ],
  "description": "The notification channel type. Currently only `email` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts/{alert_id}",
  "parameter": "notification_channel.recipients",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Email addresses that receive the spend alert notification.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_alerts/{alert_id}",
  "parameter": "notification_channel.subject_prefix",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional subject prefix for alert emails.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/spend_alerts/{alert_id}",
  "parameter": "alert_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the spend alert to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "user_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these users.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these API keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "models",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id",
   "user_id",
   "api_key_id",
   "model"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_speeches",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "user_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these users.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these API keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "models",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id",
   "user_id",
   "api_key_id",
   "model"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/audio_transcriptions",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/code_interpreter_sessions",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/code_interpreter_sessions",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/code_interpreter_sessions",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/code_interpreter_sessions",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/code_interpreter_sessions",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/code_interpreter_sessions",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/code_interpreter_sessions",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "user_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these users.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these API keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "models",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "batch",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If `true`, return batch jobs only. If `false`, return non-batch jobs only. By default, return both.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id",
   "user_id",
   "api_key_id",
   "model",
   "batch",
   "service_tier"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `batch`, `service_tier` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/completions",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "user_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these users.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these API keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "models",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id",
   "user_id",
   "api_key_id",
   "model"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/embeddings",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "user_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these users.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these API keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "vector_store_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these vector stores.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id",
   "user_id",
   "api_key_id",
   "vector_store_id"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `vector_store_id` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/file_search_calls",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "sources",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image.generation",
   "image.edit",
   "image.variation"
  ],
  "description": "Return only usages for these sources. Possible values are `image.generation`, `image.edit`, `image.variation` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "sizes",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "256x256",
   "512x512",
   "1024x1024",
   "1792x1792",
   "1024x1792"
  ],
  "description": "Return only usages for these image sizes. Possible values are `256x256`, `512x512`, `1024x1024`, `1792x1792`, `1024x1792` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "user_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these users.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these API keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "models",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id",
   "user_id",
   "api_key_id",
   "model",
   "size",
   "source"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `size`, `source` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/images",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "user_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these users.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these API keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "models",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id",
   "user_id",
   "api_key_id",
   "model"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/moderations",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/vector_stores",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/vector_stores",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/vector_stores",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/vector_stores",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/vector_stores",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/vector_stores",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/vector_stores",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "start_time",
  "location": "query",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Start time (Unix seconds) of the query time range, inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "end_time",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End time (Unix seconds) of the query time range, exclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "bucket_width",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "1d",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1m",
   "1h",
   "1d"
  ],
  "description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "project_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these projects.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "user_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these users.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "api_key_ids",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these API keys.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "models",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return only usage for these models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "context_levels",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "Return only web search usage for these context levels.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "group_by",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "project_id",
   "user_id",
   "api_key_id",
   "model",
   "context_level"
  ],
  "description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `context_level` or any combination of them.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/usage/web_search_calls",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users",
  "parameter": "emails",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter by the email address of users.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/users/{user_id}",
  "parameter": "role",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`owner` or `reader`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/users/{user_id}",
  "parameter": "role_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Role ID to assign to the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/users/{user_id}",
  "parameter": "technical_level",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Technical level metadata.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/users/{user_id}",
  "parameter": "developer_persona",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Developer persona metadata.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/users/{user_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users/{user_id}/roles",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users/{user_id}/roles",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1000,
  "enum": null,
  "description": "A limit on the number of organization role assignments to return.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users/{user_id}/roles",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the value from the previous response's `next` field to continue listing organization roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users/{user_id}/roles",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for the returned organization roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/users/{user_id}/roles",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user that should receive the organization role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/users/{user_id}/roles",
  "parameter": "role_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the role to assign.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users/{user_id}/roles/{role_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/users/{user_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the organization role to retrieve for the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/users/{user_id}/roles/{role_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user to modify.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/users/{user_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the organization role to remove from the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/groups/{group_id}/roles",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/groups/{group_id}/roles",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/groups/{group_id}/roles",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1000,
  "enum": null,
  "description": "A limit on the number of project role assignments to return.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/groups/{group_id}/roles",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the value from the previous response's `next` field to continue listing project roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/groups/{group_id}/roles",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for the returned project roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/groups/{group_id}/roles",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/groups/{group_id}/roles",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group that should receive the project role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/groups/{group_id}/roles",
  "parameter": "role_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the role to assign.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/groups/{group_id}/roles/{role_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/groups/{group_id}/roles/{role_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/groups/{group_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project role to retrieve for the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/projects/{project_id}/groups/{group_id}/roles/{role_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to modify.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/projects/{project_id}/groups/{group_id}/roles/{role_id}",
  "parameter": "group_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the group whose project role assignment should be removed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/projects/{project_id}/groups/{group_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project role to remove from the group.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/roles",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/roles",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 1000,
  "minimum": 0,
  "maximum": 1000,
  "enum": null,
  "description": "A limit on the number of roles to return. Defaults to 1000.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/roles",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the value from the previous response's `next` field to continue listing roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/roles",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for the returned roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/roles",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/roles",
  "parameter": "role_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique name for the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/roles",
  "parameter": "permissions",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Permissions to grant to the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/roles",
  "parameter": "description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional description of the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/roles/{role_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the role to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/roles/{role_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the role to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/roles/{role_id}",
  "parameter": "permissions",
  "location": "body",
  "type": "array<string> | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated set of permissions for the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/roles/{role_id}",
  "parameter": "description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New description for the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/roles/{role_id}",
  "parameter": "role_name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New name for the role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/update",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/projects/{project_id}/roles/{role_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/projects/{project_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the role to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/users/{user_id}/roles",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/users/{user_id}/roles",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/users/{user_id}/roles",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1000,
  "enum": null,
  "description": "A limit on the number of project role assignments to return.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/users/{user_id}/roles",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Provide the value from the previous response's `next` field to continue listing project roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/users/{user_id}/roles",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for the returned project roles.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/list",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/users/{user_id}/roles",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/users/{user_id}/roles",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user that should receive the project role.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/projects/{project_id}/users/{user_id}/roles",
  "parameter": "role_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the role to assign.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/create",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/users/{user_id}/roles/{role_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/users/{user_id}/roles/{role_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user to inspect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/projects/{project_id}/users/{user_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project role to retrieve for the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/projects/{project_id}/users/{user_id}/roles/{role_id}",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to modify.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/projects/{project_id}/users/{user_id}/roles/{role_id}",
  "parameter": "user_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the user whose project role assignment should be removed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/projects/{project_id}/users/{user_id}/roles/{role_id}",
  "parameter": "role_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project role to remove from the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/delete",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/external_storage",
  "parameter": "project_id",
  "location": "query",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/external_storage",
  "parameter": "after",
  "location": "query",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return external storage configurations after this ID.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/external_storage",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/external_storage",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "project_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "provider",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "provider.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "azure",
  "minimum": null,
  "maximum": null,
  "enum": [
   "azure"
  ],
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "provider.bucket",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "provider.role_arn",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "provider.tenant_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "provider.subscription_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "provider.resource_group",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "provider.account_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage",
  "parameter": "provider.container",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/external_storage/{external_storage_id}",
  "parameter": "external_storage_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/external_storage/{external_storage_id}",
  "parameter": "external_storage_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/external_storage/{external_storage_id}/validate",
  "parameter": "external_storage_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_limit",
  "parameter": "threshold_amount",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "The hard spend limit amount, in cents.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_limit",
  "parameter": "currency",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "USD"
  ],
  "description": "The currency for the threshold amount. Currently, only `USD` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/spend_limit",
  "parameter": "interval",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "month"
  ],
  "description": "The time interval for evaluating spend against the threshold. Currently, only `month` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/organization/projects/{project_id}/spend_limit",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project whose hard spend limit is being managed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_limit",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project whose hard spend limit is being managed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_limit",
  "parameter": "threshold_amount",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "The hard spend limit amount, in cents.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_limit",
  "parameter": "currency",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "USD"
  ],
  "description": "The currency for the threshold amount. Currently, only `USD` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/spend_limit",
  "parameter": "interval",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "month"
  ],
  "description": "The time interval for evaluating spend against the threshold. Currently, only `month` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/organization/projects/{project_id}/spend_limit",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project whose hard spend limit is being managed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys",
  "parameter": "project_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys",
  "parameter": "service_account_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the service account.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "API key name.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys",
  "parameter": "scopes",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "API key scopes.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys",
  "parameter": "expires_in_seconds",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-admin.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/assistants",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/assistants",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/assistants",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/assistants",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "model",
  "location": "body",
  "type": "string | AssistantSupportedModels",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-2025-08-07",
   "gpt-5-mini-2025-08-07",
   "gpt-5-nano-2025-08-07",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4.1-2025-04-14",
   "gpt-4.1-mini-2025-04-14",
   "gpt-4.1-nano-2025-04-14",
   "o3-mini",
   "o3-mini-2025-01-31",
   "o1",
   "o1-2024-12-17",
   "gpt-4o",
   "gpt-4o-2024-11-20",
   "gpt-4o-2024-08-06",
   "gpt-4o-2024-05-13",
   "gpt-4o-mini",
   "gpt-4o-mini-2024-07-18",
   "gpt-4.5-preview",
   "gpt-4.5-preview-2025-02-27",
   "gpt-4-turbo",
   "gpt-4-turbo-2024-04-09",
   "gpt-4-0125-preview",
   "gpt-4-turbo-preview",
   "gpt-4-1106-preview",
   "gpt-4-vision-preview",
   "gpt-4",
   "gpt-4-0314",
   "gpt-4-0613",
   "gpt-4-32k",
   "gpt-4-32k-0314",
   "gpt-4-32k-0613",
   "gpt-3.5-turbo",
   "gpt-3.5-turbo-16k",
   "gpt-3.5-turbo-0613",
   "gpt-3.5-turbo-1106",
   "gpt-3.5-turbo-0125",
   "gpt-3.5-turbo-16k-0613"
  ],
  "description": "ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna (live-verified)"
  ],
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "reasoning_effort",
  "location": "body",
  "type": "ReasoningEffort",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "tools",
  "location": "body",
  "type": "array<AssistantToolsCode | AssistantToolsFileSearch | AssistantToolsFunction>",
  "required": false,
  "default": [],
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "maxItems": 128,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "tool_resources",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "metadata",
  "location": "body",
  "type": "Metadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants",
  "parameter": "response_format",
  "location": "body",
  "type": "AssistantsApiResponseFormatOption | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/assistants/{assistant_id}",
  "parameter": "assistant_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the assistant to retrieve.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "assistant_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the assistant to modify.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "model",
  "location": "body",
  "type": "string | AssistantSupportedModels",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-2025-08-07",
   "gpt-5-mini-2025-08-07",
   "gpt-5-nano-2025-08-07",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4.1-2025-04-14",
   "gpt-4.1-mini-2025-04-14",
   "gpt-4.1-nano-2025-04-14",
   "o3-mini",
   "o3-mini-2025-01-31",
   "o1",
   "o1-2024-12-17",
   "gpt-4o",
   "gpt-4o-2024-11-20",
   "gpt-4o-2024-08-06",
   "gpt-4o-2024-05-13",
   "gpt-4o-mini",
   "gpt-4o-mini-2024-07-18",
   "gpt-4.5-preview",
   "gpt-4.5-preview-2025-02-27",
   "gpt-4-turbo",
   "gpt-4-turbo-2024-04-09",
   "gpt-4-0125-preview",
   "gpt-4-turbo-preview",
   "gpt-4-1106-preview",
   "gpt-4-vision-preview",
   "gpt-4",
   "gpt-4-0314",
   "gpt-4-0613",
   "gpt-4-32k",
   "gpt-4-32k-0314",
   "gpt-4-32k-0613",
   "gpt-3.5-turbo",
   "gpt-3.5-turbo-16k",
   "gpt-3.5-turbo-0613",
   "gpt-3.5-turbo-1106",
   "gpt-3.5-turbo-0125",
   "gpt-3.5-turbo-16k-0613"
  ],
  "description": "ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna (live-verified)"
  ],
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "reasoning_effort",
  "location": "body",
  "type": "ReasoningEffort",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "tools",
  "location": "body",
  "type": "array<AssistantToolsCode | AssistantToolsFileSearch | AssistantToolsFunction>",
  "required": false,
  "default": [],
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "maxItems": 128,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "tool_resources",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "Metadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/assistants/{assistant_id}",
  "parameter": "response_format",
  "location": "body",
  "type": "AssistantsApiResponseFormatOption | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/assistants/{assistant_id}",
  "parameter": "assistant_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the assistant to delete.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads",
  "parameter": "messages",
  "location": "body",
  "type": "array<CreateMessageRequest>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of [messages](https://developers.openai.com/api/docs/assistants/migration) to start the thread with.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads",
  "parameter": "tool_resources",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads",
  "parameter": "metadata",
  "location": "body",
  "type": "Metadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "assistant_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) to use to execute this run.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "thread",
  "location": "body",
  "type": "CreateThreadRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Options to create a new thread. If no thread is provided when running a\nrequest, an empty thread will be created.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "model",
  "location": "body",
  "type": "string | string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-2025-08-07",
   "gpt-5-mini-2025-08-07",
   "gpt-5-nano-2025-08-07",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4.1-2025-04-14",
   "gpt-4.1-mini-2025-04-14",
   "gpt-4.1-nano-2025-04-14",
   "gpt-4o",
   "gpt-4o-2024-11-20",
   "gpt-4o-2024-08-06",
   "gpt-4o-2024-05-13",
   "gpt-4o-mini",
   "gpt-4o-mini-2024-07-18",
   "gpt-4.5-preview",
   "gpt-4.5-preview-2025-02-27",
   "gpt-4-turbo",
   "gpt-4-turbo-2024-04-09",
   "gpt-4-0125-preview",
   "gpt-4-turbo-preview",
   "gpt-4-1106-preview",
   "gpt-4-vision-preview",
   "gpt-4",
   "gpt-4-0314",
   "gpt-4-0613",
   "gpt-4-32k",
   "gpt-4-32k-0314",
   "gpt-4-32k-0613",
   "gpt-3.5-turbo",
   "gpt-3.5-turbo-16k",
   "gpt-3.5-turbo-0613",
   "gpt-3.5-turbo-1106",
   "gpt-3.5-turbo-0125",
   "gpt-3.5-turbo-16k-0613"
  ],
  "description": "The ID of the [Model](https://developers.openai.com/api/reference/resources/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna (live-verified)"
  ],
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "tools",
  "location": "body",
  "type": "array<AssistantToolsCode | AssistantToolsFileSearch | AssistantToolsFunction>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "maxItems": 20,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "tool_resources",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "metadata",
  "location": "body",
  "type": "Metadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "top_p",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "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\nWe generally recommend altering this or temperature but not both.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "stream",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "max_prompt_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 256,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "max_completion_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 256,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "truncation_strategy",
  "location": "body",
  "type": "TruncationObject & any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "tool_choice",
  "location": "body",
  "type": "AssistantsApiToolChoiceOption & any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "parallel_tool_calls",
  "location": "body",
  "type": "ParallelToolCalls",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling) during tool use.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/runs",
  "parameter": "response_format",
  "location": "body",
  "type": "AssistantsApiResponseFormatOption",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "description": "Specifies the format that the model must output. Compatible with [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o), [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread to retrieve.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread to modify. Only the `metadata` can be modified.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}",
  "parameter": "tool_resources",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "Metadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/threads/{thread_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread to delete.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/messages",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) the messages belong to.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/messages",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/messages",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/messages",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/messages",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/messages",
  "parameter": "run_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter messages by the run ID that generated them.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/messages",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) to create a message for.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/messages",
  "parameter": "role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant"
  ],
  "description": "The role of the entity that is creating the message. Allowed values include:\n- `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n- `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/messages",
  "parameter": "content",
  "location": "body",
  "type": "string | array<MessageContentImageFileObject | MessageContentImageUrlObject | MessageRequestContentTextObject>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/messages",
  "parameter": "attachments",
  "location": "body",
  "type": "array<object> | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/messages",
  "parameter": "metadata",
  "location": "body",
  "type": "Metadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/messages/{message_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) to which this message belongs.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/messages/{message_id}",
  "parameter": "message_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the message to retrieve.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/messages/{message_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread to which this message belongs.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/messages/{message_id}",
  "parameter": "message_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the message to modify.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/messages/{message_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "Metadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/threads/{thread_id}/messages/{message_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread to which this message belongs.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/threads/{thread_id}/messages/{message_id}",
  "parameter": "message_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the message to delete.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread the run belongs to.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread to run.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "include[]",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "assistant_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) to use to execute this run.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "model",
  "location": "body",
  "type": "string | AssistantSupportedModels",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-2025-08-07",
   "gpt-5-mini-2025-08-07",
   "gpt-5-nano-2025-08-07",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4.1-2025-04-14",
   "gpt-4.1-mini-2025-04-14",
   "gpt-4.1-nano-2025-04-14",
   "o3-mini",
   "o3-mini-2025-01-31",
   "o1",
   "o1-2024-12-17",
   "gpt-4o",
   "gpt-4o-2024-11-20",
   "gpt-4o-2024-08-06",
   "gpt-4o-2024-05-13",
   "gpt-4o-mini",
   "gpt-4o-mini-2024-07-18",
   "gpt-4.5-preview",
   "gpt-4.5-preview-2025-02-27",
   "gpt-4-turbo",
   "gpt-4-turbo-2024-04-09",
   "gpt-4-0125-preview",
   "gpt-4-turbo-preview",
   "gpt-4-1106-preview",
   "gpt-4-vision-preview",
   "gpt-4",
   "gpt-4-0314",
   "gpt-4-0613",
   "gpt-4-32k",
   "gpt-4-32k-0314",
   "gpt-4-32k-0613",
   "gpt-3.5-turbo",
   "gpt-3.5-turbo-16k",
   "gpt-3.5-turbo-0613",
   "gpt-3.5-turbo-1106",
   "gpt-3.5-turbo-0125",
   "gpt-3.5-turbo-16k-0613"
  ],
  "description": "The ID of the [Model](https://developers.openai.com/api/reference/resources/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna (live-verified)"
  ],
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "reasoning_effort",
  "location": "body",
  "type": "ReasoningEffort",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Overrides the [instructions](https://developers.openai.com/api/docs/assistants/migration) of the assistant. This is useful for modifying the behavior on a per-run basis.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "additional_instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "additional_messages",
  "location": "body",
  "type": "array<CreateMessageRequest>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Adds additional messages to the thread before creating the run.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "tools",
  "location": "body",
  "type": "array<AssistantToolsCode | AssistantToolsFileSearch | AssistantToolsFunction>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "maxItems": 20,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "metadata",
  "location": "body",
  "type": "Metadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "top_p",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "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\nWe generally recommend altering this or temperature but not both.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "stream",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "max_prompt_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 256,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "max_completion_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 256,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "truncation_strategy",
  "location": "body",
  "type": "TruncationObject & any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "tool_choice",
  "location": "body",
  "type": "AssistantsApiToolChoiceOption & any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "parallel_tool_calls",
  "location": "body",
  "type": "ParallelToolCalls",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling) during tool use.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs",
  "parameter": "response_format",
  "location": "body",
  "type": "AssistantsApiResponseFormatOption",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "description": "Specifies the format that the model must output. Compatible with [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o), [GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) that was run.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run to retrieve.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs/{run_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) that was run.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs/{run_id}",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run to modify.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs/{run_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "Metadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs/{run_id}/cancel",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread to which this run belongs.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs/{run_id}/cancel",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run to cancel.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread the run and run steps belong to.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run the run steps belong to.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps",
  "parameter": "include[]",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the thread to which the run and run step belongs.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run to which the run step belongs.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}",
  "parameter": "step_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run step to retrieve.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}",
  "parameter": "include[]",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization) for more information.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) to which this run belongs.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run that requires the tool output submission.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs",
  "parameter": "tool_outputs",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools for which the outputs are being submitted.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: assistants=v2 (historical)",
  "status": [
   "RETIRED",
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/assistants/migration",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions/{session_id}/cancel",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the ChatKit session to cancel.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "workflow",
  "location": "body",
  "type": "WorkflowParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Workflow that powers the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "workflow.id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the workflow invoked by the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "workflow.version",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specific workflow version to run. Defaults to the latest deployed version.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "workflow.state_variables",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "State variables forwarded to the workflow. Keys may be up to 64 characters, values must be primitive types, and the map defaults to an empty object.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "workflow.tracing",
  "location": "body",
  "type": "WorkflowTracingParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional tracing overrides for the workflow invocation. When omitted, tracing is enabled by default.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "workflow.tracing.enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether tracing is enabled during the session. Defaults to true.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "user",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A free-form string that identifies your end user; ensures this Session can access other objects that have the same `user` scope.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "minLength": 1,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "expires_after",
  "location": "body",
  "type": "ExpiresAfterParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional override for session expiration timing in seconds from creation. Defaults to 10 minutes.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "expires_after.anchor",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "created_at",
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at"
  ],
  "description": "Base timestamp used to calculate expiration. Currently fixed to `created_at`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "expires_after.seconds",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 600,
  "enum": null,
  "description": "Number of seconds after the anchor when the session expires.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "rate_limits",
  "location": "body",
  "type": "RateLimitsParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional override for per-minute request limits. When omitted, defaults to 10.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "rate_limits.max_requests_per_1_minute",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of requests allowed per minute for the session. Defaults to 10.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration",
  "location": "body",
  "type": "ChatkitConfigurationParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional overrides for ChatKit runtime configuration features",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration.automatic_thread_titling",
  "location": "body",
  "type": "AutomaticThreadTitlingParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for automatic thread titling. When omitted, automatic thread titling is enabled by default.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration.automatic_thread_titling.enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enable automatic thread title generation. Defaults to true.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration.file_upload",
  "location": "body",
  "type": "FileUploadParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for upload enablement and limits. When omitted, uploads are disabled by default (max_files 10, max_file_size 512 MB).",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration.file_upload.enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enable uploads for this session. Defaults to false.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration.file_upload.max_file_size",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 512,
  "enum": null,
  "description": "Maximum size in megabytes for each uploaded file. Defaults to 512 MB, which is the maximum allowable size.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration.file_upload.max_files",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of files that can be uploaded to the session. Defaults to 10.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration.history",
  "location": "body",
  "type": "HistoryParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for chat history retention. When omitted, history is enabled by default with no limit on recent_threads (null).",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration.history.enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enables chat users to access previous ChatKit threads. Defaults to true.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chatkit/sessions",
  "parameter": "chatkit_configuration.history.recent_threads",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "Number of recent ChatKit threads users have access to. Defaults to unlimited when unset.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads/{thread_id}/items",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the ChatKit thread whose items are requested.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads/{thread_id}/items",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "Maximum number of thread items to return. Defaults to 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads/{thread_id}/items",
  "parameter": "order",
  "location": "query",
  "type": "OrderEnum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for results by creation time. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads/{thread_id}/items",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List items created after this thread item ID. Defaults to null for the first page.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads/{thread_id}/items",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List items created before this thread item ID. Defaults to null for the newest results.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads/{thread_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the ChatKit thread to retrieve.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/chatkit/threads/{thread_id}",
  "parameter": "thread_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier of the ChatKit thread to delete.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "Maximum number of thread items to return. Defaults to 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads",
  "parameter": "order",
  "location": "query",
  "type": "OrderEnum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for results by creation time. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List items created after this thread item ID. Defaults to null for the first page.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List items created before this thread item ID. Defaults to null for the newest results.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chatkit/threads",
  "parameter": "user",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter threads that belong to this user identifier. Defaults to null to return all users.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: chatkit_beta=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",
  "minLength": 1,
  "maxLength": 512,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/{environment_id}",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the environment.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/{environment_id}/files",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the environment.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/{environment_id}/files",
  "parameter": "path",
  "location": "query",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Restrict the listing to this absolute workspace directory.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/{environment_id}/files",
  "parameter": "limit",
  "location": "query",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "The maximum number of files to return, between 1 and 100.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/{environment_id}/files",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort by case-sensitive path components. Defaults to descending.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/{environment_id}/files",
  "parameter": "page",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The opaque token from the previous page. Keep the same path, order, and limit.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/{environment_id}/files",
  "parameter": "environment_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the environment.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/{environment_id}/files",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/{environment_id}/files",
  "parameter": "file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when type=file_id] The ID of the uploaded file.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 256,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/{environment_id}/files",
  "parameter": "path",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when type=inline] The absolute destination path inside `/workspace`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 4096,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/{environment_id}/files",
  "parameter": "data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when type=inline] The standard-base64-encoded file contents.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 6990508,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "The maximum number of resources to return, between 1 and 100. Defaults to 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order in which resources are returned. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}",
  "parameter": "subagent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the subagent in this session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/items",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/items",
  "parameter": "subagent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the subagent in this session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/items",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "The maximum number of resources to return, between 1 and 100. Defaults to 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/items",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order in which resources are returned. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/items",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns",
  "parameter": "subagent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the subagent in this session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "The maximum number of resources to return, between 1 and 100. Defaults to 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order in which resources are returned. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}",
  "parameter": "subagent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the subagent in this session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}",
  "parameter": "turn_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of a turn belonging to this subagent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items",
  "parameter": "subagent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the subagent in this session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items",
  "parameter": "turn_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of a turn belonging to this subagent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "The maximum number of resources to return, between 1 and 100. Defaults to 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order in which resources are returned. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents",
  "parameter": "limit",
  "location": "query",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of resources to return.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order in which resources are returned. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters. Omission or null defaults to an empty map.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A human-readable name for the agent. Omission or null leaves the agent unnamed.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 128,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for the agent. The requested model name is preserved.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna (live-verified)"
  ],
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "reasoning",
  "location": "body",
  "type": "ReasoningParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for model reasoning. Omission uses the model's default effort.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "reasoning.effort",
  "location": "body",
  "type": "ReasoningEffortParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "The amount of reasoning effort the model should use. Omission lets the model select it.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "reasoning.summary",
  "location": "body",
  "type": "ReasoningSummaryParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "concise",
   "detailed",
   "auto"
  ],
  "description": "Controls whether the response includes a reasoning summary.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "text",
  "location": "body",
  "type": "TextParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for generated text. Defaults to the `text` format and medium verbosity.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "text.format",
  "location": "body",
  "type": "TextFormatParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output format. Omission uses ordinary text (`{\"type\": \"text\"}`).",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "text.verbosity",
  "location": "body",
  "type": "VerbosityParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "The amount of text the model should produce. Defaults to `medium`, matching Responses.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "service_tier",
  "location": "body",
  "type": "ServiceTierParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "flex",
   "priority",
   "fast"
  ],
  "description": "The service tier used for model requests. Defaults to `auto`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional instructions appended to the agent's default base instructions. Omit or set to null to add no custom instructions.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tools available to the agent. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 2000,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "web_search",
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search"
  ],
  "description": "[when tools[].type=web_search] The type of the object. Always `web_search`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=function] The name of the function.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=function] A description of what the function does.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].parameters",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=function] A JSON Schema object describing the function's arguments.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=function] Whether this function is deferred and discovered through tool search. Defaults to `false`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=programmatic_tool_calling] Whether tools can be called from model-generated code. Defaults to `true`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] A label used to identify the MCP server in tool calls.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].credential_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] The vault credential selected for this MCP server. Optional when exactly one attached credential matches the server URL.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].transport",
  "location": "body",
  "type": "PersistedMcpTransportConfigParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] The credential-free transport used to connect to the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].transport.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "stdio",
  "minimum": null,
  "maximum": null,
  "enum": [
   "stdio"
  ],
  "description": "[when tools[].transport.type=stdio] The type of the object. Always `stdio`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].transport.server_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=http] The URL of the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].transport.headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=http] Non-secret HTTP headers sent to the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].transport.command",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=stdio] The command used to start the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].transport.args",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=stdio] Arguments passed to the MCP server command.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].transport.cwd",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=stdio] The working directory used to start the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].transport.env_vars",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=stdio] Environment variable names to inherit from the selected execution environment.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].request_metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] Metadata included with requests to this MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].allowed_tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] The MCP tools the agent may call. All server tools are allowed when omitted.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].required",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] Whether this MCP server must initialize before the first turn. Defaults to `false`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].connection_origin",
  "location": "body",
  "type": "McpConnectionOriginParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "service",
   "environment"
  ],
  "description": "[when tools[].type=mcp] Selects where outbound MCP HTTP connections originate.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].mode",
  "location": "body",
  "type": "WebSearchModeParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "disabled",
   "cached",
   "live"
  ],
  "description": "[when tools[].type=web_search] The source used for web search results. Defaults to `live`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].context_size",
  "location": "body",
  "type": "WebSearchContextSizeParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "[when tools[].type=web_search] The amount of search context made available to the model. Defaults to `medium`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].allowed_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] Domains the search may include.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].location",
  "location": "body",
  "type": "WebSearchLocationParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] Approximate location used to localize search results.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].location.country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] The two-letter ISO country code, such as `US`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].location.region",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] The region or state name.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].location.city",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] The city name.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "tools[].location.timezone",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] The IANA timezone, such as `America/Los_Angeles`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "multi_agent",
  "location": "body",
  "type": "MultiAgentConfigCurrentParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for creating and coordinating subagents. Subagent tools are disabled by default.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "multi_agent.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether subagent tools are enabled.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents",
  "parameter": "multi_agent.max_concurrent_subagents",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 4294967295,
  "enum": null,
  "description": "Maximum number of subagents that may run concurrently. Defaults to 6.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/{agent_id}",
  "parameter": "agent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the reusable agent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "agent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the reusable agent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for the agent. The requested model name is preserved.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna (live-verified)"
  ],
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "reasoning",
  "location": "body",
  "type": "ReasoningParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for model reasoning. Omit to keep the current settings; pass `null` to reset to the model's default effort.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "reasoning.effort",
  "location": "body",
  "type": "ReasoningEffortParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "The amount of reasoning effort the model should use. Omission lets the model select it.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "reasoning.summary",
  "location": "body",
  "type": "ReasoningSummaryParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "concise",
   "detailed",
   "auto"
  ],
  "description": "Controls whether the response includes a reasoning summary.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "text",
  "location": "body",
  "type": "TextParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for text generated by the agent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "text.format",
  "location": "body",
  "type": "TextFormatParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output format. Omission uses ordinary text (`{\"type\": \"text\"}`).",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "text.verbosity",
  "location": "body",
  "type": "VerbosityParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "The amount of text the model should produce. Defaults to `medium`, matching Responses.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "service_tier",
  "location": "body",
  "type": "ServiceTierParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "flex",
   "priority",
   "fast"
  ],
  "description": "The service tier used for model requests.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional instructions appended to the agent's default base instructions. Omit to leave unchanged.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multi_agent",
  "location": "body",
  "type": "MultiAgentConfigCurrentParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for creating and coordinating subagents.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multi_agent.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether subagent tools are enabled.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "multi_agent.max_concurrent_subagents",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 4294967295,
  "enum": null,
  "description": "Maximum number of subagents that may run concurrently. Defaults to 6.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it. Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A replacement name. Omit to leave unchanged, or pass null to clear it.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 128,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tools available to the agent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 2000,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "web_search",
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search"
  ],
  "description": "[when tools[].type=web_search] The type of the object. Always `web_search`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=function] The name of the function.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=function] A description of what the function does.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].parameters",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=function] A JSON Schema object describing the function's arguments.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=function] Whether this function is deferred and discovered through tool search. Defaults to `false`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=programmatic_tool_calling] Whether tools can be called from model-generated code. Defaults to `true`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] A label used to identify the MCP server in tool calls.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].credential_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] The vault credential selected for this MCP server. Optional when exactly one attached credential matches the server URL.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].transport",
  "location": "body",
  "type": "PersistedMcpTransportConfigParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] The credential-free transport used to connect to the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].transport.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "stdio",
  "minimum": null,
  "maximum": null,
  "enum": [
   "stdio"
  ],
  "description": "[when tools[].transport.type=stdio] The type of the object. Always `stdio`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].transport.server_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=http] The URL of the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].transport.headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=http] Non-secret HTTP headers sent to the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].transport.command",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=stdio] The command used to start the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].transport.args",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=stdio] Arguments passed to the MCP server command.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].transport.cwd",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=stdio] The working directory used to start the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].transport.env_vars",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].transport.type=stdio] Environment variable names to inherit from the selected execution environment.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].request_metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] Metadata included with requests to this MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].allowed_tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] The MCP tools the agent may call. All server tools are allowed when omitted.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].required",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=mcp] Whether this MCP server must initialize before the first turn. Defaults to `false`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].connection_origin",
  "location": "body",
  "type": "McpConnectionOriginParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "service",
   "environment"
  ],
  "description": "[when tools[].type=mcp] Selects where outbound MCP HTTP connections originate.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].mode",
  "location": "body",
  "type": "WebSearchModeParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "disabled",
   "cached",
   "live"
  ],
  "description": "[when tools[].type=web_search] The source used for web search results. Defaults to `live`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].context_size",
  "location": "body",
  "type": "WebSearchContextSizeParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "[when tools[].type=web_search] The amount of search context made available to the model. Defaults to `medium`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].allowed_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] Domains the search may include.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].location",
  "location": "body",
  "type": "WebSearchLocationParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] Approximate location used to localize search results.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].location.country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] The two-letter ISO country code, such as `US`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].location.region",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] The region or state name.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].location.city",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] The city name.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/{agent_id}",
  "parameter": "tools[].location.timezone",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when tools[].type=web_search] The IANA timezone, such as `America/Los_Angeles`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/agents/{agent_id}",
  "parameter": "agent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the reusable agent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/templates",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "The maximum number of resources to return, between 1 and 100. Defaults to 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/templates",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order in which resources are returned. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/templates",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "packages",
  "location": "body",
  "type": "EnvironmentPackagesParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Packages to install in the environment. Defaults to empty package lists.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "packages.python",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Python packages to install. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "packages.system",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System packages to install. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "packages.npm",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "npm packages to install globally. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "setup_commands",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ordered, confidential setup commands. Command bodies are never returned.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "setup_commands[].command",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The shell command to execute.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 65536,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "setup_commands[].cwd",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The absolute working directory. Defaults to `/workspace`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 4096,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "network",
  "location": "body",
  "type": "NetworkPolicyParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network access policy for the environment. Defaults to disabled for GA requests and enabled for alpha/beta requests.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "network.access",
  "location": "body",
  "type": "NetworkAccessParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "enabled",
   "disabled",
   "restricted"
  ],
  "description": "The environment's network access mode.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "network.allowed_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Domains the environment may access when network access is restricted.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "env",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment variables made available to the agent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "capability_directories",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Directories that contain capabilities exposed to the agent. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 200,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when skills[].type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=skill_reference] The ID of the skill created through `/v1/skills`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills[].version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=skill_reference] The skill version, a positive integer or `latest`; omission selects the default.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=inline] The skill name declared in `SKILL.md`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=inline] The skill description declared in `SKILL.md`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills[].source",
  "location": "body",
  "type": "InlineCapabilitySourceParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=inline] The inline ZIP archive.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "base64",
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "description": "[when skills[].source.type=base64] The type of the object. Always `base64`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "application/zip",
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/zip"
  ],
  "description": "[when skills[].source.type=base64] The archive media type, always `application/zip`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "skills[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].source.type=base64] Standard-base64 encoded ZIP archive bytes.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 70254592,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "plugins",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Plugins provided as inline ZIP archives. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 32,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "plugins[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when plugins[].type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "plugins[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when plugins[].type=inline] The plugin name declared in `.codex-plugin/plugin.json`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "plugins[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when plugins[].type=inline] The plugin description declared in `.codex-plugin/plugin.json`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "plugins[].source",
  "location": "body",
  "type": "InlineCapabilitySourceParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when plugins[].type=inline] The inline ZIP archive.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "plugins[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "base64",
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "description": "[when plugins[].source.type=base64] The type of the object. Always `base64`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "plugins[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "application/zip",
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/zip"
  ],
  "description": "[when plugins[].source.type=base64] The archive media type, always `application/zip`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "plugins[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when plugins[].source.type=base64] Standard-base64 encoded ZIP archive bytes.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 70254592,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "files",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files available before the agent starts. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 50,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "files[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when files[].type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "files[].file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when files[].type=file_id] The ID of the uploaded file.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 256,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "files[].path",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when files[].type=inline] The absolute destination path inside `/workspace`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 4096,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "files[].data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when files[].type=inline] The standard-base64-encoded file contents.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 6990508,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates",
  "parameter": "name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional human-readable display name for the template.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 256,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "environment_template_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the reusable environment template.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "environment_template_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the reusable environment template.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A replacement human-readable display name, or `null` to clear the name.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 256,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "packages",
  "location": "body",
  "type": "EnvironmentPackagesParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Packages installed before the runtime network policy applies.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "packages.python",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Python packages to install. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "packages.system",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System packages to install. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "packages.npm",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "npm packages to install globally. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "setup_commands",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement confidential setup commands, never included in returned resources.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "setup_commands[].command",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The shell command to execute.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 65536,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "setup_commands[].cwd",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The absolute working directory. Defaults to `/workspace`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 4096,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "network",
  "location": "body",
  "type": "NetworkPolicyParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network access available after setup completes. Omit to preserve the current policy, or pass `null` to reset to disabled for GA requests or enabled for alpha/beta requests.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "network.access",
  "location": "body",
  "type": "NetworkAccessParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "enabled",
   "disabled",
   "restricted"
  ],
  "description": "The environment's network access mode.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "network.allowed_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Domains the environment may access when network access is restricted.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "env",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement confidential environment values.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "capability_directories",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Directories that expose capabilities to the agent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement skill configuration installed for each new session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 200,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when skills[].type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=skill_reference] The ID of the skill created through `/v1/skills`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills[].version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=skill_reference] The skill version, a positive integer or `latest`; omission selects the default.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=inline] The skill name declared in `SKILL.md`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=inline] The skill description declared in `SKILL.md`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills[].source",
  "location": "body",
  "type": "InlineCapabilitySourceParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].type=inline] The inline ZIP archive.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "base64",
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "description": "[when skills[].source.type=base64] The type of the object. Always `base64`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "application/zip",
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/zip"
  ],
  "description": "[when skills[].source.type=base64] The archive media type, always `application/zip`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "skills[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when skills[].source.type=base64] Standard-base64 encoded ZIP archive bytes.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 70254592,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "plugins",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement plugin configuration installed for each new session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 32,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "plugins[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when plugins[].type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "plugins[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when plugins[].type=inline] The plugin name declared in `.codex-plugin/plugin.json`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "plugins[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when plugins[].type=inline] The plugin description declared in `.codex-plugin/plugin.json`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "plugins[].source",
  "location": "body",
  "type": "InlineCapabilitySourceParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when plugins[].type=inline] The inline ZIP archive.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "plugins[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "base64",
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "description": "[when plugins[].source.type=base64] The type of the object. Always `base64`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "plugins[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "application/zip",
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/zip"
  ],
  "description": "[when plugins[].source.type=base64] The archive media type, always `application/zip`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "plugins[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when plugins[].source.type=base64] Standard-base64 encoded ZIP archive bytes.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 70254592,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "files",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement file configuration materialized for each new session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 50,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "files[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when files[].type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "files[].file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when files[].type=file_id] The ID of the uploaded file.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 256,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "files[].path",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when files[].type=inline] The absolute destination path inside `/workspace`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 4096,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "files[].data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when files[].type=inline] The standard-base64-encoded file contents.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 6990508,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/agents/environments/templates/{environment_template_id}",
  "parameter": "environment_template_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the reusable environment template.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions",
  "parameter": "limit",
  "location": "query",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of resources to return.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions",
  "parameter": "agent_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only return sessions whose root agent has this ID. Omit to return sessions for all agents.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters. Omission or null defaults to an empty map.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent",
  "location": "body",
  "type": "SessionAgentConfigParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Agent configuration. With `agent_id`, supplied fields override the saved agent for this session. Without `agent_id`, `model` is required.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for the agent. The requested model name is preserved.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna (live-verified)"
  ],
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.reasoning",
  "location": "body",
  "type": "ReasoningParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for model reasoning. Omit to keep the current settings; pass `null` to reset to the model's default effort.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.reasoning.effort",
  "location": "body",
  "type": "ReasoningEffortParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "The amount of reasoning effort the model should use. Omission lets the model select it.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.reasoning.summary",
  "location": "body",
  "type": "ReasoningSummaryParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "concise",
   "detailed",
   "auto"
  ],
  "description": "Controls whether the response includes a reasoning summary.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.text",
  "location": "body",
  "type": "TextParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for text generated by the agent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.text.format",
  "location": "body",
  "type": "TextFormatParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output format. Omission uses ordinary text (`{\"type\": \"text\"}`).",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.text.verbosity",
  "location": "body",
  "type": "VerbosityParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "The amount of text the model should produce. Defaults to `medium`, matching Responses.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.service_tier",
  "location": "body",
  "type": "ServiceTierParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "flex",
   "priority",
   "fast"
  ],
  "description": "The service tier used for model requests.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional instructions appended to the agent's default base instructions. Omit to leave unchanged.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.multi_agent",
  "location": "body",
  "type": "MultiAgentConfigCurrentParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for creating and coordinating subagents.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.multi_agent.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether subagent tools are enabled.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.multi_agent.max_concurrent_subagents",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 4294967295,
  "enum": null,
  "description": "Maximum number of subagents that may run concurrently. Defaults to 6.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tools available to the agent. Omit to inherit, or pass null to clear them.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "web_search",
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search"
  ],
  "description": "[when agent.tools[].type=web_search] The type of the object. Always `web_search`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=function] The name of the function.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=function] A description of what the function does.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].parameters",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=function] A JSON Schema object describing the function's arguments.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=function] Whether this function is deferred and discovered through tool search. Defaults to `false`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=programmatic_tool_calling] Whether tools can be called from model-generated code. Defaults to `true`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=mcp] A label used to identify the MCP server in tool calls.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].credential_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=mcp] The attached vault credential used to authenticate this MCP server. Optional when exactly one attached credential matches the server URL.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport",
  "location": "body",
  "type": "McpTransportConfigParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=mcp] The transport used to connect to the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "stdio",
  "minimum": null,
  "maximum": null,
  "enum": [
   "stdio"
  ],
  "description": "[when agent.tools[].transport.type=stdio] The type of the object. Always `stdio`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport.server_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].transport.type=http] The URL of the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport.authorization",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].transport.type=http] The authorization value sent to the MCP server, if any.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport.headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].transport.type=http] Additional HTTP headers sent to the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport.command",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].transport.type=stdio] The command used to start the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport.args",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].transport.type=stdio] Arguments passed to the MCP server command.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport.cwd",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].transport.type=stdio] The working directory used to start the MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport.env",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].transport.type=stdio] Environment variables set for the MCP server process.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].transport.env_vars",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].transport.type=stdio] Environment variable names to inherit from the selected execution environment.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].request_metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=mcp] Metadata included with requests to this MCP server.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].allowed_tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=mcp] The MCP tools the agent may call. All server tools are allowed when omitted.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].required",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=mcp] Whether this MCP server must initialize before the first turn. Defaults to `false`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].connection_origin",
  "location": "body",
  "type": "McpConnectionOriginParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "service",
   "environment"
  ],
  "description": "[when agent.tools[].type=mcp] Selects where outbound MCP HTTP connections originate. Omitted or `service` uses the Managed Agents service network; `environment` uses the session's selected environment.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].mode",
  "location": "body",
  "type": "WebSearchModeParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "disabled",
   "cached",
   "live"
  ],
  "description": "[when agent.tools[].type=web_search] The source used for web search results. Defaults to `live`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].context_size",
  "location": "body",
  "type": "WebSearchContextSizeParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "[when agent.tools[].type=web_search] The amount of search context made available to the model. Defaults to `medium`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].allowed_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=web_search] Domains the search may include.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].location",
  "location": "body",
  "type": "WebSearchLocationParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=web_search] Approximate location used to localize search results.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].location.country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=web_search] The two-letter ISO country code, such as `US`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].location.region",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=web_search] The region or state name.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].location.city",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=web_search] The city name.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent.tools[].location.timezone",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when agent.tools[].type=web_search] The IANA timezone, such as `America/Los_Angeles`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "agent_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of a saved reusable agent. Omit `agent` to use its configuration unchanged.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment",
  "location": "body",
  "type": "EnvironmentParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An inline execution environment or a reference to an environment template.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "self_hosted",
  "minimum": null,
  "maximum": null,
  "enum": [
   "self_hosted"
  ],
  "description": "[when environment.type=self_hosted] The type of the object. Always `self_hosted`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.packages",
  "location": "body",
  "type": "EnvironmentPackagesParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] Packages to install in the environment. Defaults to empty package lists.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.packages.python",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] Python packages to install. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.packages.system",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] System packages to install. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.packages.npm",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] npm packages to install globally. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.setup_commands",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] Ordered, confidential setup commands. Command bodies are never returned.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.setup_commands[].command",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] The shell command to execute.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 65536,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.setup_commands[].cwd",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] The absolute working directory. Defaults to `/workspace`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 4096,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.network",
  "location": "body",
  "type": "NetworkPolicyParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] Network access policy for the environment. Defaults to disabled for GA requests and enabled for alpha/beta requests.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.network.access",
  "location": "body",
  "type": "NetworkAccessParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "enabled",
   "disabled",
   "restricted"
  ],
  "description": "[when environment.type=openai_hosted] The environment's network access mode.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.network.allowed_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] Domains the environment may access when network access is restricted.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.env",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] Environment variables made available to the agent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.capability_directories",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=self_hosted] Directories that contain capabilities exposed to the agent. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 200,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when environment.skills[].type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.skills[].type=skill_reference] The ID of the skill created through `/v1/skills`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills[].version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.skills[].type=skill_reference] The skill version, a positive integer or `latest`; omission selects the default.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.skills[].type=inline] The skill name declared in `SKILL.md`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.skills[].type=inline] The skill description declared in `SKILL.md`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills[].source",
  "location": "body",
  "type": "InlineCapabilitySourceParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.skills[].type=inline] The inline ZIP archive.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "base64",
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "description": "[when environment.skills[].source.type=base64] The type of the object. Always `base64`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "application/zip",
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/zip"
  ],
  "description": "[when environment.skills[].source.type=base64] The archive media type, always `application/zip`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.skills[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.skills[].source.type=base64] Standard-base64 encoded ZIP archive bytes.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 70254592,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.plugins",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] Plugins provided as inline ZIP archives. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 32,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.plugins[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when environment.plugins[].type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.plugins[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.plugins[].type=inline] The plugin name declared in `.codex-plugin/plugin.json`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.plugins[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.plugins[].type=inline] The plugin description declared in `.codex-plugin/plugin.json`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.plugins[].source",
  "location": "body",
  "type": "InlineCapabilitySourceParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.plugins[].type=inline] The inline ZIP archive.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.plugins[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "base64",
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "description": "[when environment.plugins[].source.type=base64] The type of the object. Always `base64`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.plugins[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "application/zip",
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/zip"
  ],
  "description": "[when environment.plugins[].source.type=base64] The archive media type, always `application/zip`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.plugins[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.plugins[].source.type=base64] Standard-base64 encoded ZIP archive bytes.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 70254592,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.files",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] Files available before the agent starts. Defaults to an empty list.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 50,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.files[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "inline",
  "minimum": null,
  "maximum": null,
  "enum": [
   "inline"
  ],
  "description": "[when environment.files[].type=inline] The type of the object. Always `inline`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.files[].file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.files[].type=file_id] The ID of the uploaded file.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 256,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.files[].path",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.files[].type=inline] The absolute destination path inside `/workspace`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 4096,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.files[].data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.files[].type=inline] The standard-base64-encoded file contents.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 6990508,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.environment_template_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=openai_hosted] A reusable hosted template applied before inline session configuration. Omitted fields inherit the template; network overrides cannot broaden its policy.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 64,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "environment.workspace_directory",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when environment.type=self_hosted] Absolute project directory inside the self-hosted environment.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "vault_ids",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The IDs of vaults made available to the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "input",
  "location": "body",
  "type": "CreateSessionInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Initial input to submit when the session is created. A string is shorthand for a single user message. Required when `environment.type` is `none`, or when `stream` is `true` for an environment that is not `self_hosted`; optional for self-hosted and non-streaming execution environments.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions",
  "parameter": "stream",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to stream session events as server-sent events. Defaults to `false`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}",
  "parameter": "agent",
  "location": "body",
  "type": "UpdateSessionAgentParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model settings for subsequent turns. Omitted fields stay unchanged.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}",
  "parameter": "agent.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model for subsequent turns. Omit to keep the current model.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna (live-verified)"
  ],
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}",
  "parameter": "agent.reasoning",
  "location": "body",
  "type": "UpdateSessionReasoningParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning settings to update. Omit to keep the current effort.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}",
  "parameter": "agent.reasoning.effort",
  "location": "body",
  "type": "ReasoningEffortParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "Omit to keep the current effort. Null selects the model's default effort.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}",
  "parameter": "agent.service_tier",
  "location": "body",
  "type": "ServiceTierParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "flex",
   "priority",
   "fast"
  ],
  "description": "Omit to keep the current tier. Null resets it to auto.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it. Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/agents/sessions/{session_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/artifacts",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/artifacts",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort by creation time and ID. Defaults to descending.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/artifacts",
  "parameter": "environment_id",
  "location": "query",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Restrict the listing to artifacts produced by this environment.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/artifacts",
  "parameter": "limit",
  "location": "query",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "The maximum number of artifacts to return, between 1 and 100.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/artifacts",
  "parameter": "after",
  "location": "query",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return artifacts after this immutable artifact ID.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/artifacts/{artifact_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session that owns the artifact.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/artifacts/{artifact_id}",
  "parameter": "artifact_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The immutable session artifact ID.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/agents/sessions/{session_id}/artifacts/{artifact_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session that owns the artifact.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/agents/sessions/{session_id}/artifacts/{artifact_id}",
  "parameter": "artifact_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The immutable session artifact ID.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/artifacts/{artifact_id}/content",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session that owns the artifact.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/artifacts/{artifact_id}/content",
  "parameter": "artifact_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The immutable session artifact ID.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/events",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "Idempotency-Key",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional client-generated key that makes retries of submitted messages idempotent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 1,
  "maxLength": 256,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events",
  "location": "body",
  "type": "array<SessionInputParam>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input events to submit to the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "agent.session.input.tool_result",
  "minimum": null,
  "maximum": null,
  "enum": [
   "agent.session.input.tool_result"
  ],
  "description": "[when events[].type=agent.session.input.tool_result] The type of the object. Always `agent.session.input.tool_result`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].input",
  "location": "body",
  "type": "array<InputMessageParam>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when events[].type=agent.session.input.message] The user messages to add to the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "message",
  "minimum": null,
  "maximum": null,
  "enum": [
   "message"
  ],
  "description": "[when events[].type=agent.session.input.message] The type of the input item. Always `message`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].input[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "user",
  "minimum": null,
  "maximum": null,
  "enum": [
   "user"
  ],
  "description": "[when events[].type=agent.session.input.message] The role of the message author. Always `user`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].input[].content",
  "location": "body",
  "type": "array<InputContentParam>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when events[].type=agent.session.input.message] The content of the message.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "maxItems": 16384,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_image",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": "[when events[].input[].content[].type=input_image] The type of the object. Always `input_image`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].input[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when events[].input[].content[].type=input_text] The text sent to the model.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].input[].content[].image_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when events[].input[].content[].type=input_image] The URL of the image sent to the model.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].turn_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when events[].type=agent.session.input.tool_result] The ID of the turn that requested the function call.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when events[].type=agent.session.input.tool_result] The ID of the function call.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].success",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when events[].type=agent.session.input.tool_result] Whether the function call succeeded.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].output",
  "location": "body",
  "type": "FunctionCallOutputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when events[].type=agent.session.input.tool_result] The function result when the call succeeded.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/agents/sessions/{session_id}/events",
  "parameter": "events[].error",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when events[].type=agent.session.input.tool_result] The error message when the call failed.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/items",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/items",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "The maximum number of resources to return, between 1 and 100. Defaults to 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/items",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order in which resources are returned. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/items",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/turns",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/turns",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "The maximum number of resources to return, between 1 and 100. Defaults to 20.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/turns",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order in which resources are returned. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/turns",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/turns/{turn_id}",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the session that owns the turn.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/turns/{turn_id}",
  "parameter": "turn_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the turn.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults",
  "parameter": "limit",
  "location": "query",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of resources to return. Defaults to 20. Values are clamped between 1 and 100.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults",
  "parameter": "status",
  "location": "query",
  "type": "VaultStatusFilterParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "active",
   "archived"
  ],
  "description": "Filter by one status or a list, such as `status=active` or `status[]=active&status[]=archived`. Both statuses are included by default.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 1,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Key-value pairs to associate with the vault, such as an application or team identifier.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults/{vault_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/vaults/{vault_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "order",
  "location": "query",
  "type": "ListOrderParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `desc`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "limit",
  "location": "query",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of resources to return. Defaults to 20. Values are clamped between 1 and 100.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "status",
  "location": "query",
  "type": "VaultStatusFilterParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "active",
   "archived"
  ],
  "description": "Filter by one status or a list, such as `status=active` or `status[]=active&status[]=archived`. Both statuses are included by default.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Return resources after this resource ID in the selected order.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name is trimmed before storage. It must contain 1 to 256 UTF-8 bytes after trimming.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 1,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth",
  "location": "body",
  "type": "CreateVaultCredentialAuthParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The authentication method and write-only secret values to store.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "environment_variable",
  "minimum": null,
  "maximum": null,
  "enum": [
   "environment_variable"
  ],
  "description": "[when auth.type=environment_variable] The type of the object. Always `environment_variable`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.mcp_server_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=static_bearer] The HTTPS MCP server URL authorized by this credential.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.access_token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] A write-only OAuth access token; never returned by credential resources.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.expires_at",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] When the OAuth access token expires, as an RFC 3339 timestamp, if known.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh",
  "location": "body",
  "type": "CreateMcpOauthRefreshParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] Optional refresh configuration for an HTTPS OAuth token endpoint.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] The HTTPS OAuth token endpoint used to exchange the refresh token for a new access token.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.client_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] The OAuth client ID used when requesting a new access token.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.resource",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] The resource URI to send to the OAuth token endpoint during refresh, if required.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.scope",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] Space-separated OAuth scopes to request during refresh, if required.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.refresh_token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] The refresh token to store. This secret is never returned in credential resources.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint_auth",
  "location": "body",
  "type": "CreateMcpOauthTokenEndpointAuthParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] How the OAuth client authenticates to the token endpoint.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint_auth.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "client_secret_post",
  "minimum": null,
  "maximum": null,
  "enum": [
   "client_secret_post"
  ],
  "description": "[when auth.refresh.token_endpoint_auth.type=client_secret_post] The type of the object. Always `client_secret_post`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.refresh.token_endpoint_auth.client_secret",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.refresh.token_endpoint_auth.type=client_secret_post] The OAuth client secret to store. Never returned in credential resources.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=static_bearer] The bearer token to store. This secret is never returned in credential resources.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.secret_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=environment_variable] The environment variable name that receives the placeholder, such as `SERVICE_API_KEY`. Use ASCII letters, digits, and underscores, starting with a letter or underscore. Names starting with `CODEX_` and managed proxy or certificate variable names are reserved.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 1,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.secret_value",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=environment_variable] The write-only secret to store. Never returned in credential resources or supplied directly to sandbox code. Must be nonempty and must not contain carriage returns, newlines, or NUL bytes.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 1,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.networking",
  "location": "body",
  "type": "VaultCredentialNetworkingParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=environment_variable] The destinations where the proxy can substitute this secret. The environment network policy must also allow them.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.networking.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "limited",
  "minimum": null,
  "maximum": null,
  "enum": [
   "limited"
  ],
  "description": "[when auth.networking.type=limited] The type of the object. Always `limited`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials",
  "parameter": "auth.networking.allowed_hosts",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.networking.type=limited] The 1 to 16 distinct allowed hostnames or IPv4 addresses, normalized to lowercase. Entries contain no scheme, path, port, or wildcard. IPv6 addresses are not supported.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "maxItems": 16,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "credential_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault credential.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "credential_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault credential.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth",
  "location": "body",
  "type": "RotateVaultCredentialAuthParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Replacement values for the credential's existing authentication method.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "environment_variable",
  "minimum": null,
  "maximum": null,
  "enum": [
   "environment_variable"
  ],
  "description": "[when auth.type=environment_variable] The type of the object. Always `environment_variable`.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.access_token",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] A write-only replacement OAuth access token.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.expires_at",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] The replacement expiry as an RFC 3339 timestamp, or `null` to clear it. Omitting this field preserves the expiry unless a new access token is supplied, in which case the expiry is cleared.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh",
  "location": "body",
  "type": "RotateMcpOauthRefreshParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] Optional write-only refresh-token and client-secret updates.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh.refresh_token",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] The replacement refresh token. Omit or pass `null` to keep the stored token. This secret is never returned in resources.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh.scope",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] Replacement space-separated OAuth scopes for refresh requests. Omit to keep the scopes, or pass `null` to stop sending a scope parameter.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.refresh.token_endpoint_auth",
  "location": "body",
  "type": "RotateMcpOauthTokenEndpointAuthParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=mcp_oauth] Client-secret updates for the existing token endpoint authentication method.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=static_bearer] The replacement bearer token. This secret is never returned in credential resources.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "auth.secret_value",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[when auth.type=environment_variable] The write-only replacement secret. Never returned in credential resources or supplied directly to sandbox code. Must be nonempty and must not contain carriage returns, newlines, or NUL bytes.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 1,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "vault_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/vaults/{vault_id}/credentials/{credential_id}",
  "parameter": "credential_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vault credential.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: agents=v1",
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/tools/vaults",
  "minLength": 0,
  "maxLength": 1048576,
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "all Agents/Vaults endpoints",
  "parameter": "OpenAI-Beta",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be `agents=v1`. Live: missing header -> 400 invalid_beta \"To access the Agents API, set the 'OpenAI-Beta' header to 'agents=v1'.\"; `?beta=true` is not accepted.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/quickstart",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "all ChatKit endpoints",
  "parameter": "OpenAI-Beta",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Must be `chatkit_beta=v1` (spec examples).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/quickstart",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/agents/sessions/{session_id}/events",
  "parameter": "Accept",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "text/event-stream recommended for the SSE stream (with ?stream=true).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/agents-api/quickstart",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://api.chatgpt.com/v1/workspace_agents/{id}/trigger",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public API trigger identifier of the published API channel (agtch_…).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/workspace-agents/trigger-runs",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET https://api.chatgpt.com/v1/workspace_agents/{id}/runs/{run_id}",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Trigger run id (apirun_…) returned when OpenAI-Beta: workspace_agent_runs=v1 is sent.",
  "compatible_models": null,
  "beta_header": "OpenAI-Beta: workspace_agent_runs=v1",
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/workspace-agents/trigger-runs",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://api.chatgpt.com/v1/workspace_agents/{id}/trigger",
  "parameter": "input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Message text passed to the agent as trigger input.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/workspace-agents/trigger-runs",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://api.chatgpt.com/v1/workspace_agents/{id}/trigger",
  "parameter": "conversation_key",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Caller-defined stable identifier to continue the same agent conversation across trigger events.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/workspace-agents/trigger-runs",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://api.chatgpt.com/v1/workspace_agents/{id}/trigger",
  "parameter": "Idempotency-Key",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Safe retry of the same trigger event; reuse only when retrying the same event.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/workspace-agents/trigger-runs",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://api.chatgpt.com/v1/workspace_agents/{id}/trigger",
  "parameter": "OpenAI-Beta",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`workspace_agent_runs=v1` to receive agent_trigger_run_id and enable run polling (beta).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/workspace-agents/trigger-runs",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://api.chatgpt.com/v1/workspace_agents/{id}/trigger",
  "parameter": "Authorization",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Bearer Workspace Agent access token (ChatGPT admin access-token flow), scoped to Workspace Agents API only.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/workspace-agents/trigger-runs",
  "_fragment": "generated/fragments/parameters/openai-agents.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/speech",
  "parameter": "model",
  "location": "body",
  "type": "string | enum",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tts-1",
   "tts-1-hd",
   "gpt-4o-mini-tts",
   "gpt-4o-mini-tts-2025-12-15"
  ],
  "nullable": false,
  "description": "One of the available [TTS models](https://developers.openai.com/api/docs/guides/text-to-speech): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.",
  "compatible_models": [
   "gpt-4o-mini-tts",
   "gpt-4o-mini-tts-2025-12-15",
   "tts-1",
   "tts-1-hd"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/speech",
  "parameter": "input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The text to generate audio for. The maximum length is 4096 characters.",
  "compatible_models": [
   "gpt-4o-mini-tts",
   "gpt-4o-mini-tts-2025-12-15",
   "tts-1",
   "tts-1-hd"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/speech",
  "parameter": "instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Control the voice of your generated audio with additional instructions. Does not work with `tts-1` or `tts-1-hd`.",
  "compatible_models": [
   "gpt-4o-mini-tts",
   "gpt-4o-mini-tts-2025-12-15",
   "tts-1",
   "tts-1-hd"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/speech",
  "parameter": "voice",
  "location": "body",
  "type": "VoiceIdsShared | object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A built-in voice name or a custom voice reference.",
  "compatible_models": [
   "gpt-4o-mini-tts",
   "gpt-4o-mini-tts-2025-12-15",
   "tts-1",
   "tts-1-hd"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/speech",
  "parameter": "voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The custom voice ID, e.g. `voice_1234`.",
  "compatible_models": [
   "gpt-4o-mini-tts",
   "gpt-4o-mini-tts-2025-12-15",
   "tts-1",
   "tts-1-hd"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/speech",
  "parameter": "response_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "mp3",
  "minimum": null,
  "maximum": null,
  "enum": [
   "mp3",
   "opus",
   "aac",
   "flac",
   "wav",
   "pcm"
  ],
  "nullable": false,
  "description": "The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.",
  "compatible_models": [
   "gpt-4o-mini-tts",
   "gpt-4o-mini-tts-2025-12-15",
   "tts-1",
   "tts-1-hd"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/speech",
  "parameter": "speed",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0.25,
  "maximum": 4,
  "enum": null,
  "nullable": false,
  "description": "The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default.",
  "compatible_models": [
   "gpt-4o-mini-tts",
   "gpt-4o-mini-tts-2025-12-15",
   "tts-1",
   "tts-1-hd"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/speech",
  "parameter": "stream_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "audio",
  "minimum": null,
  "maximum": null,
  "enum": [
   "sse",
   "audio"
  ],
  "nullable": false,
  "description": "The format to stream the audio in. Supported formats are `sse` and `audio`. `sse` is not supported for `tts-1` or `tts-1-hd`.",
  "compatible_models": [
   "gpt-4o-mini-tts",
   "gpt-4o-mini-tts-2025-12-15",
   "tts-1",
   "tts-1-hd"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "file",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "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.\nThe request must include enough format metadata for the file to be identified. We recommend an extension-bearing filename and an appropriate content type.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "model",
  "location": "body",
  "type": "string | enum",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "whisper-1",
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-mini-transcribe-2025-12-15",
   "gpt-4o-transcribe-diarize"
  ],
  "nullable": false,
  "description": "ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `whisper-1` (which is powered by our open source Whisper V2 model), and `gpt-4o-transcribe-diarize`.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format will improve accuracy and latency.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "languages",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe`.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "keywords",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe`.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting) should match the audio language. This field is not supported when using `gpt-4o-transcribe-diarize`.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "response_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "json",
  "minimum": null,
  "maximum": null,
  "enum": [
   "json",
   "text",
   "srt",
   "verbose_json",
   "vtt",
   "diarized_json"
  ],
  "nullable": false,
  "description": "The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, `vtt`, or `diarized_json`. For `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`, the only supported format is `json`. For `gpt-4o-transcribe-diarize`, the supported formats are `json`, `text`, and `diarized_json`, with `diarized_json` required to receive speaker annotations.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 0,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "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](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "include",
  "location": "body",
  "type": "array<TranscriptionInclude>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Additional information to include in the transcription response.\n`logprobs` will return the log probabilities of the tokens in the\nresponse to understand the model's confidence in the transcription.\n`logprobs` only works with response_format set to `json` and only with\nthe models `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, and `gpt-4o-mini-transcribe-2025-12-15`. This field is not supported when using `gpt-4o-transcribe-diarize`.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "timestamp_granularities",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": [
   "segment"
  ],
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The timestamp granularities to populate for this transcription. `response_format` must be set `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.\nThis option is not available for `gpt-4o-transcribe-diarize`.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "chunking_strategy",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "chunking_strategy.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server_vad"
  ],
  "nullable": false,
  "description": "Must be set to `server_vad` to enable manual chunking using server side VAD.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "variant": "VadConfig",
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "chunking_strategy.prefix_padding_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 300,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Amount of audio to include before the VAD detected speech (in \nmilliseconds).",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "variant": "VadConfig",
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "chunking_strategy.silence_duration_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 200,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Duration of silence to detect speech stop (in milliseconds).\nWith shorter values the model will respond more quickly, \nbut may jump in on short pauses from the user.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "variant": "VadConfig",
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "chunking_strategy.threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 0.5,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Sensitivity threshold (0.0 to 1.0) for voice activity detection. A \nhigher threshold will require louder audio to activate the model, and \nthus might perform better in noisy environments.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "variant": "VadConfig",
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "known_speaker_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional list of speaker names that correspond to the audio samples provided in `known_speaker_references[]`. Each entry should be a short identifier (for example `customer` or `agent`). Up to 4 speakers are supported.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/transcriptions",
  "parameter": "known_speaker_references",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional list of audio samples (as [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs)) that contain known speaker references matching `known_speaker_names[]`. Each sample must be between 2 and 10 seconds, and can use any of the same input audio formats supported by `file`.",
  "compatible_models": [
   "gpt-transcribe",
   "gpt-4o-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-transcribe-diarize",
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/translations",
  "parameter": "file",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough format metadata for the file to be identified. We recommend an extension-bearing filename and an appropriate content type.",
  "compatible_models": [
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/translations/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/translations",
  "parameter": "model",
  "location": "body",
  "type": "string | enum",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "whisper-1"
  ],
  "nullable": false,
  "description": "ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.",
  "compatible_models": [
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/translations/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/translations",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting) should be in English.",
  "compatible_models": [
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/translations/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/translations",
  "parameter": "response_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "json",
  "minimum": null,
  "maximum": null,
  "enum": [
   "json",
   "text",
   "srt",
   "verbose_json",
   "vtt"
  ],
  "nullable": false,
  "description": "The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.",
  "compatible_models": [
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/translations/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/translations",
  "parameter": "temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 0,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "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](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.",
  "compatible_models": [
   "whisper-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/translations/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/voices",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the new voice.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voices/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/voices",
  "parameter": "audio_sample",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The sample audio recording file. Maximum size is 10 MiB.\n\nSupported MIME types:\n`audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`, `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voices/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/voices",
  "parameter": "consent",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The consent recording ID (for example, `cons_1234`).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voices/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/voice_consents",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The label to use for this consent recording.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/voice_consents",
  "parameter": "recording",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The consent audio recording file. Maximum size is 10 MiB.\n\nSupported MIME types:\n`audio/mpeg`, `audio/wav`, `audio/x-wav`, `audio/ogg`, `audio/aac`, `audio/flac`, `audio/webm`, `audio/mp4`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/voice_consents",
  "parameter": "language",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The BCP 47 language tag for the consent phrase (for example, `en-US`).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/create",
   "retrieved_at": "2026-09-19T01:31:50Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/voice_consents/{consent_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The updated label for this consent recording.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/audio/voice_consents/{consent_id}",
  "parameter": "consent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/audio/voice_consents",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Cursor for pagination (object ID).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/list",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/audio/voice_consents",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "nullable": false,
  "description": "1–100, default 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/list",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/audio/voice_consents/{consent_id}",
  "parameter": "consent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/retrieve",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/audio/voice_consents/{consent_id}",
  "parameter": "consent_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/audio/subresources/voice_consents/methods/delete",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "modalities",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "audio"
  ],
  "nullable": false,
  "description": " For audio output use `[\"text\",\"audio\"]`. LIVE 2026-09-18: gpt-audio-mini with `modalities:[\"text\"]` and text-only input → 400 `This model requires that either input content or output modality contain audio.`",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "audio.voice",
  "location": "body",
  "type": "VoiceIdsShared | object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A built-in voice name or a custom voice reference.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "audio.voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The custom voice ID, e.g. `voice_1234`.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "audio.format",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "wav",
   "aac",
   "mp3",
   "flac",
   "opus",
   "pcm16"
  ],
  "nullable": false,
  "description": "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`,\n`opus`, or `pcm16`.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "messages[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_audio"
  ],
  "nullable": false,
  "description": "The type of the content part. Always `input_audio`.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "messages[].content[].input_audio",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "messages[].content[].input_audio.data",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64 encoded audio data.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "messages[].content[].input_audio.format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "wav",
   "mp3"
  ],
  "nullable": false,
  "description": "The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "messages[].content[].prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions (audio subset)",
  "parameter": "messages[].content[].prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "nullable": false,
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-audio",
   "gpt-audio-mini",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/audio-chat-completions",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-audio.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/batches",
  "parameter": "input_file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of an uploaded file that contains requests for the new batch.\n\nSee [upload file](https://developers.openai.com/api/reference/resources/files/methods/create) for how to upload a file.\n\nYour input file must be formatted as a [JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file), and must be uploaded with the purpose `batch`. The file can contain up to 50,000 requests, and can be up to 200 MB in size.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/batches",
  "parameter": "endpoint",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "/v1/responses",
   "/v1/chat/completions",
   "/v1/embeddings",
   "/v1/completions",
   "/v1/moderations",
   "/v1/images/generations",
   "/v1/images/edits",
   "/v1/videos"
  ],
  "description": "The endpoint to be used for all requests in the batch. Currently `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`, `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and `/v1/videos` are supported. Note that `/v1/embeddings` batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/batches",
  "parameter": "completion_window",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "24h"
  ],
  "description": "The time frame within which the batch should be processed. Currently only `24h` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/batches",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: Metadata]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/batches",
  "parameter": "output_expires_after",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The expiration policy for the output and/or error file that are generated for a batch. [schema: BatchFileExpirationAfter]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/batches",
  "parameter": "output_expires_after.anchor",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at"
  ],
  "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`. Note that the anchor is the file creation time, not the time the batch is created.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/batches",
  "parameter": "output_expires_after.seconds",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 3600,
  "maximum": 2592000,
  "enum": null,
  "description": "The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/batches",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/batches",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/batches/{batch_id}",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the batch to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/batches/{batch_id}/cancel",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the batch to cancel.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/batches",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "input_file (JSONL line)",
  "parameter": "custom_id",
  "location": "file",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique per line; echoed in the output/error lines (output order is not guaranteed).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "input_file (JSONL line)",
  "parameter": "method",
  "location": "file",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "POST"
  ],
  "description": "Always POST.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "input_file (JSONL line)",
  "parameter": "url",
  "location": "file",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "/v1/responses",
   "/v1/chat/completions",
   "/v1/embeddings",
   "/v1/completions",
   "/v1/moderations",
   "/v1/images/generations",
   "/v1/images/edits",
   "/v1/videos"
  ],
  "description": "Must equal the batch `endpoint`; all lines target one endpoint and one model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "input_file (JSONL line)",
  "parameter": "body",
  "location": "file",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Same JSON body as the synchronous endpoint (stream must be false/absent; videos/images must be JSON not multipart, assets referenced by file_id/image_url).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file",
  "_fragment": "generated/fragments/parameters/openai-batch.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "metadata",
  "location": "body",
  "type": "map<string,string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "schema_ref": "Metadata",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "top_logprobs",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 20,
  "enum": null,
  "description": "An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested. `logprobs` must be set to `true` if this parameter is used.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "notes": "Live p7: top_logprobs=1 + include=[\"message.output_text.logprobs\"] returns output_text.logprobs[] with token/logprob/bytes/top_logprobs.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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. We generally recommend altering this or `top_p` but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "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. We generally recommend altering this or `temperature` but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "notes": "Live: gpt-5.4-nano reports top_p=0.98 when omitted (documented default is 1).",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "user",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "notes": "Deprecated: replaced by safety_identifier + prompt_cache_key. Live l10: still accepted.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "safety_identifier",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prompt_cache_key",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "notes": "Live n: same key + same ~1.5k-token prefix twice on gpt-5.4-nano -> cached_tokens=0 both times (no hit within 1.5 s); chat gpt-4.1-nano -> 1408 cached of 1556 on 2nd call.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prompt_cache_retention",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_memory",
   "24h"
  ],
  "description": "Deprecated. Use `prompt_cache_options.ttl` instead. The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). This field expresses a maximum retention policy, while `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: - Organizations without ZDR enabled default to `24h`. - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.",
  "compatible_models": [
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.4",
   "gpt-5.2",
   "gpt-5.1-codex-max",
   "gpt-5.1",
   "gpt-5.1-codex",
   "gpt-5.1-codex-mini",
   "gpt-5.1-chat-latest",
   "gpt-5",
   "gpt-5-codex",
   "gpt-4.1",
   "(in_memory: all cache-capable models)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "notes": "Deprecated in favour of prompt_cache_options.ttl (GPT-5.6+). Live: response echoes \"24h\" by default and \"in_memory\" when requested.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prompt_cache_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheOptionsParam",
  "notes": "GPT-5.6+ only. Live p12: gpt-5.4-nano -> 400 invalid_parameter \"prompt_cache_options is not supported on this model\".",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prompt_cache_options.ttl",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "30m"
  ],
  "description": "The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. Defaults to `30m`, which is currently the only supported value. The backend may retain cache entries for longer.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheTTLEnum",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prompt_cache_options.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "implicit",
   "explicit"
  ],
  "description": "Controls whether OpenAI automatically creates an implicit cache breakpoint. Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint and writes up to the latest three explicit breakpoints in the request. With `explicit`, OpenAI does not create an implicit breakpoint and writes up to the latest four explicit breakpoints. If there are no explicit breakpoints, the request does not use prompt caching.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheModeEnum",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of messages comprising the conversation so far. Depending on the [model](https://developers.openai.com/api/docs/models) you use, different message types (modalities) are supported, like [text](https://developers.openai.com/api/docs/guides/text), [images](https://developers.openai.com/api/docs/guides/images-vision), and [audio](https://developers.openai.com/api/docs/guides/audio).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "ChatCompletionRequestMessage",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](developer)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, `developer` messages replace the previous `system` messages.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "ChatCompletionRequestDeveloperMessage",
  "schema_ref": "ChatCompletionRequestDeveloperMessage",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](developer).content",
  "location": "body",
  "type": "string | array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The contents of the developer message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](developer).content[]",
  "location": "body",
  "type": "array<object> | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of content parts with a defined type. For developer messages, only type `text` is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](developer).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "developer"
  ],
  "description": "The role of the messages author, in this case `developer`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](developer).name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](system)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, use `developer` messages for this purpose instead.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "ChatCompletionRequestSystemMessage",
  "schema_ref": "ChatCompletionRequestSystemMessage",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](system).content",
  "location": "body",
  "type": "string | array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The contents of the system message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](system).content[]",
  "location": "body",
  "type": "array<object> | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of content parts with a defined type. For system messages, only type `text` is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](system).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "system"
  ],
  "description": "The role of the messages author, in this case `system`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](system).name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Messages sent by an end user, containing prompts or additional context information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "ChatCompletionRequestUserMessage",
  "schema_ref": "ChatCompletionRequestUserMessage",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content",
  "location": "body",
  "type": "string | array<object<text> | object<image_url> | object<input_audio> | object<file>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The contents of the user message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[]",
  "location": "body",
  "type": "array<object<text> | object<image_url> | object<input_audio> | object<file>> | object<text> | object<file>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of content parts with a defined type. Supported options differ based on the [model](https://developers.openai.com/api/docs/models) being used to generate the response. Can contain text, image, or audio inputs.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user"
  ],
  "description": "The role of the messages author, in this case `user`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Messages sent by the model in response to user messages.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "ChatCompletionRequestAssistantMessage",
  "schema_ref": "ChatCompletionRequestAssistantMessage",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).content",
  "location": "body",
  "type": "string | array<object<text> | object<refusal>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).content[]",
  "location": "body",
  "type": "array<object<text> | object<refusal>> | object<text> | object<refusal>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).refusal",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The refusal message by the assistant.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "assistant"
  ],
  "description": "The role of the messages author, in this case `assistant`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).audio",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Data about a previous audio response from the model. [Learn more](https://developers.openai.com/api/docs/guides/audio).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).audio.id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for a previous audio response from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls",
  "location": "body",
  "type": "array<object<function> | object<custom>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tool calls generated by the model, such as function calls.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "ChatCompletionMessageToolCalls",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[]",
  "location": "body",
  "type": "object<function> | object<custom>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](function)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A call to a function tool created by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "function",
  "schema_ref": "ChatCompletionMessageToolCall",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](custom)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A call to a custom tool created by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "custom",
  "schema_ref": "ChatCompletionMessageCustomToolCall",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).function_call",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).function_call.arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).function_call.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](tool)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "ChatCompletionRequestToolMessage",
  "schema_ref": "ChatCompletionRequestToolMessage",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](tool).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool"
  ],
  "description": "The role of the messages author, in this case `tool`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](tool).content",
  "location": "body",
  "type": "string | array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The contents of the tool message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](tool).content[]",
  "location": "body",
  "type": "array<object> | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of content parts with a defined type. For tool messages, only type `text` is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](tool).tool_call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tool call that this message is responding to.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](function)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "ChatCompletionRequestFunctionMessage",
  "schema_ref": "ChatCompletionRequestFunctionMessage",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](function).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": "The role of the messages author, in this case `function`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](function).content",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The contents of the function message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](function).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model ID used to generate the response, like `gpt-6-astra` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "ModelIdsShared",
  "notes": "Live models used: gpt-5.4-nano (responses), gpt-4.1-nano (chat/vision), gpt-3.5-turbo-instruct (completions).",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "service_tier",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "flex",
   "scale",
   "priority",
   "fast"
  ],
  "description": "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. - When not set, the default behavior is 'auto'",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "schema_ref": "ServiceTier",
  "notes": "Requested \"auto\" is echoed as the effective tier (\"default\" live). fast/priority/flex/scale availability depends on model & account.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "modalities",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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](https://developers.openai.com/api/docs/guides/audio). To request that this model generate both text and audio responses, you can use: `[\"text\", \"audio\"]`",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "schema_ref": "ResponseModalities",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "modalities[]",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "audio"
  ],
  "description": "",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "verbosity",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. The default is `medium`.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4*",
   "gpt-5.2*",
   "gpt-5.1*",
   "gpt-5*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "schema_ref": "Verbosity",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "reasoning_effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "Constrains effort on reasoning for reasoning models. Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for model-specific support.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "schema_ref": "ReasoningEffort",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "max_completion_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "frequency_penalty",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 0,
  "minimum": -2,
  "maximum": 2,
  "enum": 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "presence_penalty",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 0,
  "minimum": -2,
  "maximum": 2,
  "enum": 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Chat Completions web search (search models gpt-5-search-api, gpt-4o(-mini)-search-preview): {user_location: {type: approximate, approximate: {country, region, city, timezone}}, search_context_size}.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.user_location",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Approximate location parameters for the search.",
  "compatible_models": [
   "gpt-4o-search-preview",
   "gpt-4o-mini-search-preview",
   "gpt-5* (web search via chat)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.user_location.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "approximate"
  ],
  "description": "The type of location approximation. Always `approximate`.",
  "compatible_models": [
   "gpt-4o-search-preview",
   "gpt-4o-mini-search-preview",
   "gpt-5* (web search via chat)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.user_location.approximate",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Approximate location parameters for the search.",
  "compatible_models": [
   "gpt-4o-search-preview",
   "gpt-4o-mini-search-preview",
   "gpt-5* (web search via chat)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "WebSearchLocation",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.user_location.approximate.country",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`.",
  "compatible_models": [
   "gpt-4o-search-preview",
   "gpt-4o-mini-search-preview",
   "gpt-5* (web search via chat)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.user_location.approximate.region",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free text input for the region of the user, e.g. `California`.",
  "compatible_models": [
   "gpt-4o-search-preview",
   "gpt-4o-mini-search-preview",
   "gpt-5* (web search via chat)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.user_location.approximate.city",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free text input for the city of the user, e.g. `San Francisco`.",
  "compatible_models": [
   "gpt-4o-search-preview",
   "gpt-4o-mini-search-preview",
   "gpt-5* (web search via chat)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.user_location.approximate.timezone",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`.",
  "compatible_models": [
   "gpt-4o-search-preview",
   "gpt-4o-mini-search-preview",
   "gpt-5* (web search via chat)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.search_context_size",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.",
  "compatible_models": [
   "gpt-4o-search-preview",
   "gpt-4o-mini-search-preview",
   "gpt-5* (web search via chat)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "WebSearchContextSize",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format",
  "location": "body",
  "type": "object<text> | object<json_schema> | object<json_object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object specifying the format that the model must output. Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs). Setting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which ensures the message the model generates is valid JSON. Using `json_schema` is preferred for models that support it.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(text)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default response format. Used to generate text responses.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "text",
  "schema_ref": "ResponseFormatText",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "The type of response format being defined. Always `text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(json_schema)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "json_schema",
  "schema_ref": "ResponseFormatJsonSchema",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(json_schema).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_schema"
  ],
  "description": "The type of response format being defined. Always `json_schema`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(json_schema).json_schema",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Structured Outputs configuration options, including a JSON Schema.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(json_schema).json_schema.description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of what the response format is for, used by the model to determine how to respond in the format.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(json_schema).json_schema.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(json_schema).json_schema.schema",
  "location": "body",
  "type": "map<string,any>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "ResponseFormatJsonSchemaSchema",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(json_schema).json_schema.strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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`. To learn more, read the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(json_object)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "json_object",
  "schema_ref": "ResponseFormatJsonObject",
  "notes": "JSON mode: requires the word JSON in the messages.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format(json_object).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_object"
  ],
  "description": "The type of response format being defined. Always `json_object`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "audio",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Parameters for audio output. Required when audio output is requested with `modalities: [\"audio\"]`. [Learn more](https://developers.openai.com/api/docs/guides/audio).",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "audio.voice",
  "location": "body",
  "type": "string | object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The voice the model uses to respond. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ \"id\": \"voice_1234\" }`.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "VoiceIdsOrCustomVoice",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "audio.voice(object)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Custom voice reference.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "audio.voice(object).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The custom voice ID, e.g. `voice_1234`.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "audio.format",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "wav",
   "aac",
   "mp3",
   "flac",
   "opus",
   "pcm16"
  ],
  "description": "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, or `pcm16`.",
  "compatible_models": [
   "gpt-audio-1.5",
   "gpt-4o-audio-preview",
   "gpt-4o-mini-audio-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "store",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether or not to store the output of this chat completion request for use in our [model distillation](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#distilling-from-a-larger-model) or [evals](https://developers.openai.com/api/docs/guides/evals) products. Supports text and image inputs. Note: image inputs over 8MB will be dropped.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "notes": "Default true for Responses (30-day retention); store=false responses cannot be retrieved (live d2: GET -> 404). Chat Completions default is false.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "moderation",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for running moderation on the request input and generated output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "moderation.model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "moderation.policy",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The policy to apply to moderated response input and output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "moderation.policy.input",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The moderation policy for the response input.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "moderation.policy.input.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "score",
   "block"
  ],
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "ModerationMode",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "moderation.policy.output",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The moderation policy for the response output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "moderation.policy.output.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "score",
   "block"
  ],
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "ModerationMode",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section below](https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events) for more information, along with the [streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses) guide for more information on how to handle the streaming events.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "notes": "SSE; event names equal data.type. Live sequence for plain text: response.created, response.in_progress, response.output_item.added, response.content_part.added, response.output_text.delta*, response.output_text.done, response.content_part.done, response.output_item.done, response.completed. Background streams add response.queued.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stop",
  "location": "body",
  "type": "string | null | array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Not supported with latest reasoning models `o3` and `o4-mini`. Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "schema_ref": "StopConfiguration",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stop[]",
  "location": "body",
  "type": "array<string> | string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "logit_bias",
  "location": "body",
  "type": "map<string,integer>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "logprobs",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": 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`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "max_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the chat completion. This value can be used to control [costs](https://openai.com/api/pricing/) for text generated via API. This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with [o-series models](https://developers.openai.com/api/docs/guides/reasoning).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "notes": "Deprecated in favour of max_completion_tokens; incompatible with o-series/reasoning models. Live l10: still accepted on gpt-4.1-nano.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "n",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": 1,
  "minimum": 1,
  "maximum": 128,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prediction",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for a [Predicted Output](https://developers.openai.com/api/docs/guides/predicted-outputs), which can greatly improve response times when large parts of the model response are known ahead of time. This is most common when you are regenerating a file with only minor changes to most of the content.",
  "compatible_models": [
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prediction.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "content"
  ],
  "description": "The type of the predicted content you want to provide. This type is currently always `content`.",
  "compatible_models": [
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prediction.content",
  "location": "body",
  "type": "string | array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content that should be matched when generating a model response. If generated tokens would match this content, the entire model response can be returned much more quickly.",
  "compatible_models": [
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prediction.content[]",
  "location": "body",
  "type": "array<object> | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of content parts with a defined type. Supported options differ based on the [model](https://developers.openai.com/api/docs/models) being used to generate the response. Can contain text inputs.",
  "compatible_models": [
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prediction.content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "The type of the content part.",
  "compatible_models": [
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prediction.content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": [
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prediction.content[].prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheBreakpointParam",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prediction.content[].prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": -9223372036854776000,
  "maximum": 9223372036854776000,
  "enum": null,
  "description": "This feature is in Beta. 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. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "notes": "Marked deprecated + beta in spec. Live l10: accepted; system_fingerprint returned.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stream_options",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Options for streaming response. Only set this when you set `stream: true`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "nullable": true,
  "schema_ref": "ChatCompletionStreamOptions",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stream_options.include_usage",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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. **NOTE:** If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "notes": "Live l2: final chunk has choices=[] and usage populated, then data: [DONE].",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stream_options.include_obfuscation",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an `obfuscation` field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set `include_obfuscation` to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools",
  "location": "body",
  "type": "array<object<function> | object<custom>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools the model may call. You can provide either [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools) or [function tools](https://developers.openai.com/api/docs/guides/function-calling).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "notes": "Tool definitions are documented by the tools fragments (generated/fragments/tools/**); only the shape is referenced here.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[]",
  "location": "body",
  "type": "object<function> | object<custom>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[](function)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A function tool that can be used to generate a response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "function",
  "schema_ref": "ChatCompletionTool",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[](custom)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A custom tool that processes input using a specified format.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "custom",
  "schema_ref": "CustomToolChatCompletions",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice",
  "location": "body",
  "type": "string | object<allowed_tools> | object<function> | object<custom>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. Specifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool. `none` is the default when no tools are present. `auto` is the default if tools are present.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "ChatCompletionToolChoiceOption",
  "notes": "Detailed per-tool tool_choice objects are documented by the tools fragments.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(allowed_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Constrains the tools available to the model to a pre-defined set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "allowed_tools",
  "schema_ref": "ChatCompletionAllowedToolsChoice",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(allowed_tools).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "allowed_tools"
  ],
  "description": "Allowed tool configuration type. Always `allowed_tools`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(allowed_tools).allowed_tools",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Constrains the tools available to the model to a pre-defined set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "ChatCompletionAllowedTools",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(allowed_tools).allowed_tools.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "required"
  ],
  "description": "Constrains the tools available to the model to a pre-defined set. `auto` allows the model to pick from among the allowed tools and generate a message. `required` requires the model to call one or more of the allowed tools.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(allowed_tools).allowed_tools.tools",
  "location": "body",
  "type": "array<map<string,any>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tool definitions that the model should be allowed to call. For the Chat Completions API, the list of tool definitions might look like: ```json [ { \"type\": \"function\", \"function\": { \"name\": \"get_weather\" } }, { \"type\": \"function\", \"function\": { \"name\": \"get_time\" } } ] ```",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(allowed_tools).allowed_tools.tools[]",
  "location": "body",
  "type": "map<string,any>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool definition that the model should be allowed to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(function)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies a tool the model should use. Use to force the model to call a specific function.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "function",
  "schema_ref": "ChatCompletionNamedToolChoice",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(function).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": "For function calling, the type is always `function`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(function).function",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(function).function.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(custom)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies a tool the model should use. Use to force the model to call a specific custom tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "custom",
  "schema_ref": "ChatCompletionNamedToolChoiceCustom",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(custom).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom"
  ],
  "description": "For custom tool calling, the type is always `custom`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(custom).custom",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice(custom).custom.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the custom tool to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "parallel_tool_calls",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling) during tool use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "function_call",
  "location": "body",
  "type": "string | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Deprecated in favor of `tool_choice`. Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function. `none` is the default when no functions are present. `auto` is the default if functions are present.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "notes": "Legacy; use tool_choice.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "function_call(object)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "variant": "ChatCompletionFunctionCallOption",
  "schema_ref": "ChatCompletionFunctionCallOption",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "function_call(object).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "functions",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "notes": "Legacy function calling; use tools.",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "functions[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "ChatCompletionFunctions",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "functions[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of what the function does, used by the model to choose when and how to call the function.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "functions[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "functions[].parameters",
  "location": "body",
  "type": "map<string,any>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://developers.openai.com/api/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "FunctionParameters",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](developer).content[](text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "The type of the content part.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](developer).content[](text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](developer).content[](text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheBreakpointParam",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](developer).content[](text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](system).content[](text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "The type of the content part.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](system).content[](text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](system).content[](text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheBreakpointParam",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](system).content[](text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "The type of the content part.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheBreakpointParam",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](image_url).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image_url"
  ],
  "description": "The type of the content part.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](image_url).image_url",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](image_url).image_url.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Either a URL of the image or the base64 encoded image data.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](image_url).image_url.detail",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "high"
  ],
  "description": "Specifies the detail level of the image. Learn more in the [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](image_url).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheBreakpointParam",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](image_url).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](input_audio).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_audio"
  ],
  "description": "The type of the content part. Always `input_audio`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](input_audio).input_audio",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](input_audio).input_audio.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Base64 encoded audio data.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](input_audio).input_audio.format",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "wav",
   "mp3"
  ],
  "description": "The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](input_audio).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheBreakpointParam",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](input_audio).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](file).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "file"
  ],
  "description": "The type of the content part. Always `file`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](file).file",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](file).file.filename",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the file, used when passing the file to the model as a string.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](file).file.file_data",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The base64 encoded file data, used when passing the file to the model as a string.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](file).file.file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of an uploaded file to use as input.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](file).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheBreakpointParam",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](user).content[](file).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).content[](text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "The type of the content part.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).content[](text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).content[](text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheBreakpointParam",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).content[](text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).content[](refusal).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "refusal"
  ],
  "description": "The type of the content part.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).content[](refusal).refusal",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The refusal message generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](function).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](function).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": "The type of the tool. Currently, only `function` is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](function).function",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The function that the model called.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](function).function.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](function).function.arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](custom).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](custom).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom"
  ],
  "description": "The type of the tool. Always `custom`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](custom).custom",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The custom tool that the model called.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](custom).custom.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the custom tool to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](assistant).tool_calls[](custom).custom.input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input for the custom tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](tool).content[](text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "The type of the content part.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](tool).content[](text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](tool).content[](text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "schema_ref": "PromptCacheBreakpointParam",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[](tool).content[](text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chat/completions",
  "parameter": "model",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model used to generate the Chat Completions.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/list",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chat/completions",
  "parameter": "metadata",
  "location": "query",
  "type": "map<string,string> | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of metadata keys to filter the Chat Completions by. Example: `metadata[key1]=value1&metadata[key2]=value2`",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/list",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chat/completions",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last chat completion from the previous pagination request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/list",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chat/completions",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of Chat Completions to retrieve.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/list",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chat/completions",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for Chat Completions by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/list",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chat/completions/{completion_id}/messages",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last message from the previous pagination request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/subresources/messages/methods/list",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chat/completions/{completion_id}/messages",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of messages to retrieve.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/subresources/messages/methods/list",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/chat/completions/{completion_id}/messages",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for messages by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/subresources/messages/methods/list",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions/{completion_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map<string,string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Set of 16 key-value pairs (keys <= 64 chars, values <= 512 chars) replacing the stored completion metadata. Only stored completions (store=true) can be updated.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/update",
  "_fragment": "generated/fragments/parameters/openai-chat-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the model to use. You can use the [List models](https://developers.openai.com/api/reference/resources/models/methods/list) API to see all of your available models, or see our [Model overview](https://developers.openai.com/api/docs/models) for descriptions of them.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "notes": "Live models used: gpt-5.4-nano (responses), gpt-4.1-nano (chat/vision), gpt-3.5-turbo-instruct (completions).",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "prompt",
  "location": "body",
  "type": "string | array<string> | array<integer> | array<array<integer>>",
  "required": true,
  "default": "<|endoftext|>",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays. Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "notes": "Prompt templates (reusable prompts from the dashboard); variables may be strings or input_text/input_image/input_file parts.",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "prompt[]",
  "location": "body",
  "type": "array<string> | string | array<integer> | integer | array<array<integer>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "prompt[][]",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "best_of",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 20,
  "enum": null,
  "description": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed. When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`. **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "echo",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Echo back the prompt in addition to the completion",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "frequency_penalty",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 0,
  "minimum": -2,
  "maximum": 2,
  "enum": 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. [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "logit_bias",
  "location": "body",
  "type": "map<string,integer>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. As an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "logprobs",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 5,
  "enum": null,
  "description": "Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. The maximum value for `logprobs` is 5.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "max_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": 16,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion. The token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "notes": "Deprecated in favour of max_completion_tokens; incompatible with o-series/reasoning models. Live l10: still accepted on gpt-4.1-nano.",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "n",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": 1,
  "minimum": 1,
  "maximum": 128,
  "enum": null,
  "description": "How many completions to generate for each prompt. **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "presence_penalty",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 0,
  "minimum": -2,
  "maximum": 2,
  "enum": 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. [See more information about frequency and presence penalties.](https://developers.openai.com/api/docs/guides/text)",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": 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. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "notes": "Marked deprecated + beta in spec. Live l10: accepted; system_fingerprint returned.",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "stop",
  "location": "body",
  "type": "string | null | array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Not supported with latest reasoning models `o3` and `o4-mini`. Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "schema_ref": "StopConfiguration",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "stop[]",
  "location": "body",
  "type": "array<string> | string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "notes": "SSE; event names equal data.type. Live sequence for plain text: response.created, response.in_progress, response.output_item.added, response.content_part.added, response.output_text.delta*, response.output_text.done, response.content_part.done, response.output_item.done, response.completed. Background streams add response.queued.",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "stream_options",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Options for streaming response. Only set this when you set `stream: true`.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "schema_ref": "ChatCompletionStreamOptions",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "stream_options.include_usage",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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. **NOTE:** If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "notes": "Live l2: final chunk has choices=[] and usage populated, then data: [DONE].",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "stream_options.include_obfuscation",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an `obfuscation` field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set `include_obfuscation` to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "suffix",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The suffix that comes after a completion of inserted text. This parameter is only supported for `gpt-3.5-turbo-instruct`.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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. We generally recommend altering this or `top_p` but not both.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "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. We generally recommend altering this or `temperature` but not both.",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "nullable": true,
  "notes": "Live: gpt-5.4-nano reports top_p=0.98 when omitted (documented default is 1).",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/completions",
  "parameter": "user",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).",
  "compatible_models": [
   "gpt-3.5-turbo-instruct",
   "davinci-002",
   "babbage-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/completions/methods/create",
  "notes": "Deprecated: replaced by safety_identifier + prompt_cache_key. Live l10: still accepted.",
  "_fragment": "generated/fragments/parameters/openai-completions.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "metadata",
  "location": "body",
  "type": "map<string,string> | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items",
  "location": "body",
  "type": "array<object<message> | object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Initial items to include in the conversation context. You may add up to 20 items at a time.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[]",
  "location": "body",
  "type": "object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "InputItem",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A message input to the model with a role indicating instruction following hierarchy. Instructions given with the `developer` or `system` role take precedence over instructions given with the `user` role. Messages with the `assistant` role are presumed to have been generated by the model in previous interactions.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "message",
  "schema_ref": "EasyInputMessage",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant",
   "system",
   "developer"
  ],
  "description": "The role of the message input. One of `user`, `assistant`, `system`, or `developer`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content",
  "location": "body",
  "type": "string | array<object<input_text> | object<input_image> | object<input_file>> | array<object<output_text> | object<refusal>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[]",
  "location": "body",
  "type": "array<object<input_text> | object<input_image> | object<input_file>> | object<input_text> | object<input_file> | object<output_text> | object<refusal>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of one or many input items to the model, containing different content types.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "InputMessageContentList",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).phase",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "commentary",
   "final_answer"
  ],
  "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "message"
  ],
  "description": "The type of the message input. Always `message`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the output message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](file_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a file search tool call. See the [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "file_search_call",
  "schema_ref": "FileSearchToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](file_search_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the file search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](file_search_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "file_search_call"
  ],
  "description": "The type of the file search tool call. Always `file_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](file_search_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "searching",
   "completed",
   "incomplete",
   "failed"
  ],
  "description": "The status of the file search tool call. One of `in_progress`, `searching`, `incomplete` or `failed`,",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](file_search_call).queries",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The queries used to search for files.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](file_search_call).queries[]",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](file_search_call).results",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of the file search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](file_search_call).results[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to a computer use tool. See the [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "computer_call",
  "schema_ref": "ComputerToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_call"
  ],
  "description": "The type of the computer call. Always `computer_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An identifier used when responding to the tool call with output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action",
  "location": "body",
  "type": "object<click> | object<double_click> | object<drag> | object<keypress> | object<move> | object<screenshot> | object<scroll> | object<type> | object<wait>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ComputerAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action(click)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A click action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "click",
  "schema_ref": "ClickParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action(double_click)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A double click action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "double_click",
  "schema_ref": "DoubleClickAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action(drag)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A drag action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "drag",
  "schema_ref": "DragParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action(keypress)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A collection of keypresses the model would like to perform.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "keypress",
  "schema_ref": "KeyPressAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action(move)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A mouse move action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "move",
  "schema_ref": "MoveParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action(screenshot)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A screenshot action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "screenshot",
  "schema_ref": "ScreenshotParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action(scroll)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A scroll action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "scroll",
  "schema_ref": "ScrollParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action(type)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An action to type in text.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "type",
  "schema_ref": "TypeParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).action(wait)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A wait action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "wait",
  "schema_ref": "WaitParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).actions",
  "location": "body",
  "type": "array<object<click> | object<double_click> | object<drag> | object<keypress> | object<move> | object<screenshot> | object<scroll> | object<type> | object<wait>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Flattened batched actions for `computer_use`. Each action includes an `type` discriminator and action-specific fields.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ComputerActionList",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).actions[]",
  "location": "body",
  "type": "object<click> | object<double_click> | object<drag> | object<keypress> | object<move> | object<screenshot> | object<scroll> | object<type> | object<wait>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ComputerAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).pending_safety_checks",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The pending safety checks for the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).pending_safety_checks[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A pending safety check for the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ComputerCallSafetyCheckParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a computer tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "computer_call_output",
  "schema_ref": "ComputerCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the computer tool call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the computer tool call that produced the output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_call_output"
  ],
  "description": "The type of the computer tool call output. Always `computer_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).output",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A computer screenshot image used with the computer use tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ComputerScreenshotImage",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).output.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer_screenshot",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_screenshot"
  ],
  "description": "Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).output.image_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the screenshot image.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).output.file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of an uploaded file that contains the screenshot.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).acknowledged_safety_checks",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The safety checks reported by the API that have been acknowledged by the developer.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).acknowledged_safety_checks[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A pending safety check for the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ComputerCallSafetyCheckParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](computer_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](web_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a web search tool call. See the [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "web_search_call",
  "schema_ref": "WebSearchToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](web_search_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the web search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](web_search_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search_call"
  ],
  "description": "The type of the web search tool call. Always `web_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](web_search_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "searching",
   "completed",
   "failed",
   "incomplete"
  ],
  "description": "The status of the web search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "WebSearchCallStatus",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](web_search_call).action",
  "location": "body",
  "type": "object<search> | object<open_page> | object<find_in_page>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](web_search_call).action(search)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Action type \"search\" - Performs a web search query.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "search",
  "schema_ref": "WebSearchActionSearch",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](web_search_call).action(open_page)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Action type \"open_page\" - Opens a specific URL from search results.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "open_page",
  "schema_ref": "WebSearchActionOpenPage",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](web_search_call).action(find_in_page)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Action type \"find_in_page\": Searches for a pattern within a loaded page.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "find_in_page",
  "schema_ref": "WebSearchActionFind",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a function. See the [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "function_call",
  "schema_ref": "FunctionToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function_call"
  ],
  "description": "The type of the function tool call. Always `function_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCaller",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCaller",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).namespace",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace of the function to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the arguments to pass to the function.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call).async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the function tool call runs asynchronously.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "function_call_output",
  "schema_ref": "FunctionCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call output. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "function_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function_call_output"
  ],
  "description": "The type of the function tool call output. Always `function_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).output",
  "location": "body",
  "type": "string | array<object<input_text> | object<input_image> | object<input_file>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or file output of the function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).output[]",
  "location": "body",
  "type": "array<object<input_text> | object<input_image> | object<input_file>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of content outputs (text, image, file) for the function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool that produced the output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).namespace",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace of the tool that produced the output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](function_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "tool_search_call",
  "schema_ref": "ToolSearchCallItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_call).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this tool search call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_call).call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool search call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "tool_search_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_call"
  ],
  "description": "The item type. Always `tool_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_call).execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server",
   "client"
  ],
  "description": "Whether tool search was executed by the server or by the client.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ToolSearchExecutionType",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_call).arguments",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The arguments supplied to the tool search call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "EmptyModelParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_call).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the tool search call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "tool_search_output",
  "schema_ref": "ToolSearchOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this tool search output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_output).call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool search call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "tool_search_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_output"
  ],
  "description": "The item type. Always `tool_search_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_output).execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server",
   "client"
  ],
  "description": "Whether tool search was executed by the server or by the client.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ToolSearchExecutionType",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_output).tools",
  "location": "body",
  "type": "array<object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The loaded tool definitions returned by the tool search output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_output).tools[]",
  "location": "body",
  "type": "object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that can be used to generate a response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "Tool",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](tool_search_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the tool search output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](additional_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "additional_tools",
  "schema_ref": "AdditionalToolsItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](additional_tools).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this additional tools item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](additional_tools).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "additional_tools",
  "minimum": null,
  "maximum": null,
  "enum": [
   "additional_tools"
  ],
  "description": "The item type. Always `additional_tools`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](additional_tools).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "developer",
  "minimum": null,
  "maximum": null,
  "enum": [
   "developer"
  ],
  "description": "The role that provided the additional tools. Only `developer` is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](additional_tools).tools",
  "location": "body",
  "type": "array<object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of additional tools made available at this item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](additional_tools).tools[]",
  "location": "body",
  "type": "object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that can be used to generate a response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "Tool",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](configuration_update)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An update to the conversation's response configuration. The configuration remains in effect for subsequent responses until it is replaced by another configuration update.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "configuration_update",
  "schema_ref": "ResponseConfigurationUpdateItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](configuration_update).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the configuration update item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](configuration_update).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "configuration_update",
  "minimum": null,
  "maximum": null,
  "enum": [
   "configuration_update"
  ],
  "description": "The item type. Always `configuration_update`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](configuration_update).reasoning",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updates to reasoning configuration. Only effort is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](configuration_update).reasoning.effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "The reasoning effort to use for subsequent responses until another configuration update replaces it.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "schema_ref": "ReasoningEffort",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](reasoning)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your `input` to the Responses API for subsequent turns of a conversation if you are manually [managing context](https://developers.openai.com/api/docs/guides/conversation-state).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "reasoning",
  "schema_ref": "ReasoningItem",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](reasoning).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "reasoning"
  ],
  "description": "The type of the object. Always `reasoning`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](reasoning).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique identifier of the reasoning content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](reasoning).encrypted_content",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The encrypted content of the reasoning item. This is populated by default for reasoning items returned by `POST /v1/responses` and WebSocket `response.create` requests. When streaming, use the completed reasoning item and its `encrypted_content` from the `response.output_item.done` event in subsequent requests. The `encrypted_content` in `response.output_item.added` may be incomplete. This is especially important when `store` is `false` or when using Zero Data Retention.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](reasoning).summary",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning summary content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](reasoning).summary[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A summary text from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "SummaryTextContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](reasoning).content",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](reasoning).content[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning text from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ReasoningTextContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](reasoning).status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](compaction)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "compaction",
  "schema_ref": "CompactionSummaryItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](compaction).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the compaction item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](compaction).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "compaction",
  "minimum": null,
  "maximum": null,
  "enum": [
   "compaction"
  ],
  "description": "The type of the item. Always `compaction`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](compaction).encrypted_content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The encrypted content of the compaction summary.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image generation request made by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "image_generation_call",
  "schema_ref": "ImageGenToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image_generation_call"
  ],
  "description": "The type of the image generation call. Always `image_generation_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the image generation call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "generating",
   "failed"
  ],
  "description": "The status of the image generation call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).result",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The generated image encoded in base64.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).size",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).quality",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max",
   "auto"
  ],
  "description": "The quality of the image generated by the image generation tool call. One of `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).action",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "generate",
   "edit",
   "auto"
  ],
  "description": "The action used for image generation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).background",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "transparent",
   "opaque",
   "auto"
  ],
  "description": "The background setting used for generation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).output_format",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "png",
   "webp",
   "jpeg"
  ],
  "description": "The output format used for generation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](image_generation_call).revised_prompt",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The prompt that was used after any model prompt rewriting.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](code_interpreter_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run code.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "code_interpreter_call",
  "schema_ref": "CodeInterpreterToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](code_interpreter_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "code_interpreter_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "code_interpreter_call"
  ],
  "description": "The type of the code interpreter tool call. Always `code_interpreter_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](code_interpreter_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the code interpreter tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](code_interpreter_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete",
   "interpreting",
   "failed"
  ],
  "description": "The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](code_interpreter_call).container_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the container used to run the code.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](code_interpreter_call).code",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The code to run, or null if not available.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](code_interpreter_call).outputs",
  "location": "body",
  "type": "array<object<logs> | object<image>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](code_interpreter_call).outputs[]",
  "location": "body",
  "type": "object<logs> | object<image>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a command on the local shell.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "local_shell_call",
  "schema_ref": "LocalShellToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "local_shell_call"
  ],
  "description": "The type of the local shell call. Always `local_shell_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the local shell call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the local shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).action",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Execute a shell command on the server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "LocalShellExecAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).action.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "exec",
  "minimum": null,
  "maximum": null,
  "enum": [
   "exec"
  ],
  "description": "The type of the local shell action. Always `exec`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).action.command",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The command to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).action.timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional timeout in milliseconds for the command.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).action.working_directory",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional working directory to run the command in.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).action.env",
  "location": "body",
  "type": "map<string,string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment variables to set for the command.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).action.user",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional user to run the command as.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the local shell call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a local shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "local_shell_call_output",
  "schema_ref": "LocalShellToolCallOutput",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "local_shell_call_output"
  ],
  "description": "The type of the local shell tool call output. Always `local_shell_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call_output).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the local shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call_output).output",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the output of the local shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](local_shell_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool representing a request to execute one or more shell commands.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "shell_call",
  "schema_ref": "FunctionShellCallItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "shell_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "shell_call"
  ],
  "description": "The type of the item. Always `shell_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).action",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The shell commands and limits that describe how to run the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "FunctionShellActionParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).action.commands",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ordered shell commands for the execution environment to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).action.timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum wall-clock time in milliseconds to allow the shell commands to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).action.max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of UTF-8 characters to capture from combined stdout and stderr output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).environment",
  "location": "body",
  "type": "object<local> | object<container_reference>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The environment to execute the shell commands in.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).environment(local)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "local",
  "schema_ref": "LocalEnvironmentParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call).environment(container_reference)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "container_reference",
  "schema_ref": "ContainerReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output items emitted by a shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "shell_call_output",
  "schema_ref": "FunctionShellCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call output. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "shell_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "shell_call_output"
  ],
  "description": "The type of the item. Always `shell_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).output",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Captured chunks of stdout and stderr output, along with their associated outcomes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).output[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Captured stdout and stderr for a portion of a shell tool call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "FunctionShellCallOutputContentParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the shell call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](shell_call_output).max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of UTF-8 characters captured for this shell call's combined output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call representing a request to create, delete, or update files using diff patches.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "apply_patch_call",
  "schema_ref": "ApplyPatchToolCallItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "apply_patch_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "apply_patch_call"
  ],
  "description": "The type of the item. Always `apply_patch_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed"
  ],
  "description": "The status of the apply patch tool call. One of `in_progress` or `completed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ApplyPatchCallStatusParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).operation",
  "location": "body",
  "type": "object<create_file> | object<delete_file> | object<update_file>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The specific create, delete, or update instruction for the apply_patch tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ApplyPatchOperationParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).operation(create_file)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Instruction for creating a new file via the apply_patch tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "create_file",
  "schema_ref": "ApplyPatchCreateFileOperationParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).operation(delete_file)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Instruction for deleting an existing file via the apply_patch tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "delete_file",
  "schema_ref": "ApplyPatchDeleteFileOperationParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call).operation(update_file)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Instruction for updating an existing file via the apply_patch tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "update_file",
  "schema_ref": "ApplyPatchUpdateFileOperationParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output emitted by an apply patch tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "apply_patch_call_output",
  "schema_ref": "ApplyPatchToolCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "apply_patch_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "apply_patch_call_output"
  ],
  "description": "The type of the item. Always `apply_patch_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call output. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call_output).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call_output).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call_output).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "completed",
   "failed"
  ],
  "description": "The status of the apply patch tool call output. One of `completed` or `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ApplyPatchCallOutputStatusParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](apply_patch_call_output).output",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional human-readable log text from the apply patch tool (e.g., patch results or errors).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_list_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools available on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "mcp_list_tools",
  "schema_ref": "MCPListTools",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_list_tools).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_list_tools"
  ],
  "description": "The type of the item. Always `mcp_list_tools`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_list_tools).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the list.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_list_tools).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_list_tools).tools",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tools available on the server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_list_tools).tools[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool available on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "MCPListToolsTool",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_list_tools).error",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Error message if the server could not list tools.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_request)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A request for human approval of a tool invocation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "mcp_approval_request",
  "schema_ref": "MCPApprovalRequest",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_request).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_approval_request"
  ],
  "description": "The type of the item. Always `mcp_approval_request`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_request).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the approval request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_request).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server making the request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_request).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_request).arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of arguments for the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_response)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A response to an MCP approval request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "mcp_approval_response",
  "schema_ref": "MCPApprovalResponse",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_response).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_approval_response"
  ],
  "description": "The type of the item. Always `mcp_approval_response`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_response).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the approval response",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_response).approval_request_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the approval request being answered.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_response).approve",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the request was approved.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_approval_response).reason",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional reason for the decision.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An invocation of a tool on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "mcp_call",
  "schema_ref": "MCPToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_call"
  ],
  "description": "The type of the item. Always `mcp_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server running the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool that was run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the arguments passed to the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).output",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output from the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).error",
  "location": "body",
  "type": "object<mcp_protocol_error> | object<mcp_tool_execution_error> | object<http_error>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The error from the tool call, if any.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).error(mcp_protocol_error)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "mcp_protocol_error",
  "schema_ref": "MCPProtocolError",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).error(mcp_tool_execution_error)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "mcp_tool_execution_error",
  "schema_ref": "MCPToolExecutionError",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).error(http_error)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "http_error",
  "schema_ref": "HTTPError",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete",
   "calling",
   "failed"
  ],
  "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "MCPToolCallStatus",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](mcp_call).approval_request_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the MCP tool call approval request. Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a custom tool call from your code, being sent back to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "custom_tool_call_output",
  "schema_ref": "CustomToolCallOutput",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom_tool_call_output"
  ],
  "description": "The type of the custom tool call output. Always `custom_tool_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call_output).id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the custom tool call output in the OpenAI platform.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The call ID, used to map this custom tool call output to a custom tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call_output).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call_output).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call_output).output",
  "location": "body",
  "type": "string | array<object<input_text> | object<input_image> | object<input_file>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output from the custom tool call generated by your code. Can be a string or an list of output content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call_output).output[]",
  "location": "body",
  "type": "array<object<input_text> | object<input_image> | object<input_file>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or file output of the custom tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A call to a custom tool created by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "custom_tool_call",
  "schema_ref": "CustomToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom_tool_call"
  ],
  "description": "The type of the custom tool call. Always `custom_tool_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the custom tool call in the OpenAI platform.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An identifier used to map this custom tool call to a tool call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCaller",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCaller",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).namespace",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace of the custom tool being called.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the custom tool being called.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input for the custom tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](custom_tool_call).async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the custom tool call runs asynchronously.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](compaction_trigger)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Compacts the current context. Must be the final input item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "compaction_trigger",
  "schema_ref": "CompactionTriggerItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](compaction_trigger).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this compaction trigger.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](compaction_trigger).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "compaction_trigger",
  "minimum": null,
  "maximum": null,
  "enum": [
   "compaction_trigger"
  ],
  "description": "The type of the item. Always `compaction_trigger`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](item_reference)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An internal identifier for an item to reference.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "ItemReferenceParam",
  "schema_ref": "ItemReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](item_reference).type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "item_reference",
  "minimum": null,
  "maximum": null,
  "enum": [
   "item_reference"
  ],
  "description": "The type of item to reference. Always `item_reference`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](item_reference).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the item to reference.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program",
  "schema_ref": "ProgramItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "program",
  "minimum": null,
  "maximum": null,
  "enum": [
   "program"
  ],
  "description": "The item type. Always `program`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The stable call ID of the program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program).code",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The JavaScript source executed by programmatic tool calling.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program).fingerprint",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque program replay fingerprint that must be round-tripped.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "program_output",
  "schema_ref": "ProgramOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program_output).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this program output item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "program_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "program_output"
  ],
  "description": "The item type. Always `program_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The call ID of the program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program_output).result",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The result produced by the program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](program_output).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "completed",
   "incomplete"
  ],
  "description": "The terminal status of the program output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ProgramOutputItemStatus",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_text)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "input_text",
  "schema_ref": "InputTextContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text"
  ],
  "description": "The type of the input item. Always `input_text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_image)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "input_image",
  "schema_ref": "InputImageContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_image).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_image",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": "The type of the input item. Always `input_image`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_image).image_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_image).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_image).detail",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "high",
   "auto",
   "original"
  ],
  "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "ImageDetail",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_image).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_image).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_file)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A file input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "variant": "input_file",
  "schema_ref": "InputFileContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_file).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_file",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_file"
  ],
  "description": "The type of the input item. Always `input_file`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_file).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_file).filename",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_file).file_data",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_file).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_file).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_file).file_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations",
  "parameter": "items[](message).content[](input_file).detail",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "high"
  ],
  "description": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/create",
  "schema_ref": "FileInputDetail",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items",
  "location": "body",
  "type": "array<object<message> | object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Initial items to include in the conversation context. You may add up to 20 items at a time.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[]",
  "location": "body",
  "type": "object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "InputItem",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A message input to the model with a role indicating instruction following hierarchy. Instructions given with the `developer` or `system` role take precedence over instructions given with the `user` role. Messages with the `assistant` role are presumed to have been generated by the model in previous interactions.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "message",
  "schema_ref": "EasyInputMessage",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant",
   "system",
   "developer"
  ],
  "description": "The role of the message input. One of `user`, `assistant`, `system`, or `developer`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content",
  "location": "body",
  "type": "string | array<object<input_text> | object<input_image> | object<input_file>> | array<object<output_text> | object<refusal>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[]",
  "location": "body",
  "type": "array<object<input_text> | object<input_image> | object<input_file>> | object<input_text> | object<input_file> | object<output_text> | object<refusal>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of one or many input items to the model, containing different content types.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "InputMessageContentList",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).phase",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "commentary",
   "final_answer"
  ],
  "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "message"
  ],
  "description": "The type of the message input. Always `message`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the output message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](file_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a file search tool call. See the [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "file_search_call",
  "schema_ref": "FileSearchToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](file_search_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the file search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](file_search_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "file_search_call"
  ],
  "description": "The type of the file search tool call. Always `file_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](file_search_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "searching",
   "completed",
   "incomplete",
   "failed"
  ],
  "description": "The status of the file search tool call. One of `in_progress`, `searching`, `incomplete` or `failed`,",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](file_search_call).queries",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The queries used to search for files.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](file_search_call).queries[]",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](file_search_call).results",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of the file search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](file_search_call).results[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to a computer use tool. See the [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "computer_call",
  "schema_ref": "ComputerToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_call"
  ],
  "description": "The type of the computer call. Always `computer_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An identifier used when responding to the tool call with output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action",
  "location": "body",
  "type": "object<click> | object<double_click> | object<drag> | object<keypress> | object<move> | object<screenshot> | object<scroll> | object<type> | object<wait>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ComputerAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action(click)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A click action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "click",
  "schema_ref": "ClickParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action(double_click)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A double click action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "double_click",
  "schema_ref": "DoubleClickAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action(drag)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A drag action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "drag",
  "schema_ref": "DragParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action(keypress)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A collection of keypresses the model would like to perform.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "keypress",
  "schema_ref": "KeyPressAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action(move)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A mouse move action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "move",
  "schema_ref": "MoveParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action(screenshot)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A screenshot action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "screenshot",
  "schema_ref": "ScreenshotParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action(scroll)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A scroll action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "scroll",
  "schema_ref": "ScrollParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action(type)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An action to type in text.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "type",
  "schema_ref": "TypeParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).action(wait)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A wait action.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "wait",
  "schema_ref": "WaitParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).actions",
  "location": "body",
  "type": "array<object<click> | object<double_click> | object<drag> | object<keypress> | object<move> | object<screenshot> | object<scroll> | object<type> | object<wait>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Flattened batched actions for `computer_use`. Each action includes an `type` discriminator and action-specific fields.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ComputerActionList",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).actions[]",
  "location": "body",
  "type": "object<click> | object<double_click> | object<drag> | object<keypress> | object<move> | object<screenshot> | object<scroll> | object<type> | object<wait>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ComputerAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).pending_safety_checks",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The pending safety checks for the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).pending_safety_checks[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A pending safety check for the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ComputerCallSafetyCheckParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a computer tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "computer_call_output",
  "schema_ref": "ComputerCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the computer tool call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the computer tool call that produced the output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_call_output"
  ],
  "description": "The type of the computer tool call output. Always `computer_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).output",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A computer screenshot image used with the computer use tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ComputerScreenshotImage",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).output.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer_screenshot",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_screenshot"
  ],
  "description": "Specifies the event type. For a computer screenshot, this property is always set to `computer_screenshot`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).output.image_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the screenshot image.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).output.file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of an uploaded file that contains the screenshot.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).acknowledged_safety_checks",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The safety checks reported by the API that have been acknowledged by the developer.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).acknowledged_safety_checks[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A pending safety check for the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ComputerCallSafetyCheckParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](computer_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](web_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a web search tool call. See the [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "web_search_call",
  "schema_ref": "WebSearchToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](web_search_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the web search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](web_search_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search_call"
  ],
  "description": "The type of the web search tool call. Always `web_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](web_search_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "searching",
   "completed",
   "failed",
   "incomplete"
  ],
  "description": "The status of the web search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "WebSearchCallStatus",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](web_search_call).action",
  "location": "body",
  "type": "object<search> | object<open_page> | object<find_in_page>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](web_search_call).action(search)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Action type \"search\" - Performs a web search query.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "search",
  "schema_ref": "WebSearchActionSearch",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](web_search_call).action(open_page)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Action type \"open_page\" - Opens a specific URL from search results.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "open_page",
  "schema_ref": "WebSearchActionOpenPage",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](web_search_call).action(find_in_page)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Action type \"find_in_page\": Searches for a pattern within a loaded page.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "find_in_page",
  "schema_ref": "WebSearchActionFind",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a function. See the [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "function_call",
  "schema_ref": "FunctionToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function_call"
  ],
  "description": "The type of the function tool call. Always `function_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCaller",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCaller",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).namespace",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace of the function to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the arguments to pass to the function.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call).async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the function tool call runs asynchronously.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "function_call_output",
  "schema_ref": "FunctionCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call output. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "function_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function_call_output"
  ],
  "description": "The type of the function tool call output. Always `function_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).output",
  "location": "body",
  "type": "string | array<object<input_text> | object<input_image> | object<input_file>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or file output of the function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).output[]",
  "location": "body",
  "type": "array<object<input_text> | object<input_image> | object<input_file>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of content outputs (text, image, file) for the function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool that produced the output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).namespace",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace of the tool that produced the output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](function_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "tool_search_call",
  "schema_ref": "ToolSearchCallItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_call).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this tool search call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_call).call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool search call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "tool_search_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_call"
  ],
  "description": "The item type. Always `tool_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_call).execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server",
   "client"
  ],
  "description": "Whether tool search was executed by the server or by the client.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ToolSearchExecutionType",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_call).arguments",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The arguments supplied to the tool search call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "EmptyModelParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_call).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the tool search call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "tool_search_output",
  "schema_ref": "ToolSearchOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this tool search output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_output).call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool search call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "tool_search_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_output"
  ],
  "description": "The item type. Always `tool_search_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_output).execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server",
   "client"
  ],
  "description": "Whether tool search was executed by the server or by the client.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ToolSearchExecutionType",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_output).tools",
  "location": "body",
  "type": "array<object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The loaded tool definitions returned by the tool search output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_output).tools[]",
  "location": "body",
  "type": "object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that can be used to generate a response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "Tool",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](tool_search_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the tool search output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](additional_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "additional_tools",
  "schema_ref": "AdditionalToolsItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](additional_tools).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this additional tools item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](additional_tools).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "additional_tools",
  "minimum": null,
  "maximum": null,
  "enum": [
   "additional_tools"
  ],
  "description": "The item type. Always `additional_tools`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](additional_tools).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "developer",
  "minimum": null,
  "maximum": null,
  "enum": [
   "developer"
  ],
  "description": "The role that provided the additional tools. Only `developer` is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](additional_tools).tools",
  "location": "body",
  "type": "array<object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of additional tools made available at this item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](additional_tools).tools[]",
  "location": "body",
  "type": "object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that can be used to generate a response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "Tool",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](configuration_update)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An update to the conversation's response configuration. The configuration remains in effect for subsequent responses until it is replaced by another configuration update.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "configuration_update",
  "schema_ref": "ResponseConfigurationUpdateItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](configuration_update).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the configuration update item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](configuration_update).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "configuration_update",
  "minimum": null,
  "maximum": null,
  "enum": [
   "configuration_update"
  ],
  "description": "The item type. Always `configuration_update`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](configuration_update).reasoning",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updates to reasoning configuration. Only effort is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](configuration_update).reasoning.effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "The reasoning effort to use for subsequent responses until another configuration update replaces it.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "schema_ref": "ReasoningEffort",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](reasoning)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your `input` to the Responses API for subsequent turns of a conversation if you are manually [managing context](https://developers.openai.com/api/docs/guides/conversation-state).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "reasoning",
  "schema_ref": "ReasoningItem",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](reasoning).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "reasoning"
  ],
  "description": "The type of the object. Always `reasoning`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](reasoning).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique identifier of the reasoning content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](reasoning).encrypted_content",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The encrypted content of the reasoning item. This is populated by default for reasoning items returned by `POST /v1/responses` and WebSocket `response.create` requests. When streaming, use the completed reasoning item and its `encrypted_content` from the `response.output_item.done` event in subsequent requests. The `encrypted_content` in `response.output_item.added` may be incomplete. This is especially important when `store` is `false` or when using Zero Data Retention.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](reasoning).summary",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning summary content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](reasoning).summary[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A summary text from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "SummaryTextContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](reasoning).content",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](reasoning).content[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning text from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ReasoningTextContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](reasoning).status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](compaction)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "compaction",
  "schema_ref": "CompactionSummaryItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](compaction).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the compaction item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](compaction).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "compaction",
  "minimum": null,
  "maximum": null,
  "enum": [
   "compaction"
  ],
  "description": "The type of the item. Always `compaction`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](compaction).encrypted_content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The encrypted content of the compaction summary.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image generation request made by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "image_generation_call",
  "schema_ref": "ImageGenToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image_generation_call"
  ],
  "description": "The type of the image generation call. Always `image_generation_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the image generation call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "generating",
   "failed"
  ],
  "description": "The status of the image generation call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).result",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The generated image encoded in base64.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).size",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).quality",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max",
   "auto"
  ],
  "description": "The quality of the image generated by the image generation tool call. One of `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).action",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "generate",
   "edit",
   "auto"
  ],
  "description": "The action used for image generation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).background",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "transparent",
   "opaque",
   "auto"
  ],
  "description": "The background setting used for generation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).output_format",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "png",
   "webp",
   "jpeg"
  ],
  "description": "The output format used for generation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](image_generation_call).revised_prompt",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The prompt that was used after any model prompt rewriting.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](code_interpreter_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run code.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "code_interpreter_call",
  "schema_ref": "CodeInterpreterToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](code_interpreter_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "code_interpreter_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "code_interpreter_call"
  ],
  "description": "The type of the code interpreter tool call. Always `code_interpreter_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](code_interpreter_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the code interpreter tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](code_interpreter_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete",
   "interpreting",
   "failed"
  ],
  "description": "The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](code_interpreter_call).container_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the container used to run the code.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](code_interpreter_call).code",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The code to run, or null if not available.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](code_interpreter_call).outputs",
  "location": "body",
  "type": "array<object<logs> | object<image>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](code_interpreter_call).outputs[]",
  "location": "body",
  "type": "object<logs> | object<image>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a command on the local shell.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "local_shell_call",
  "schema_ref": "LocalShellToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "local_shell_call"
  ],
  "description": "The type of the local shell call. Always `local_shell_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the local shell call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the local shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).action",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Execute a shell command on the server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "LocalShellExecAction",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).action.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "exec",
  "minimum": null,
  "maximum": null,
  "enum": [
   "exec"
  ],
  "description": "The type of the local shell action. Always `exec`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).action.command",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The command to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).action.timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional timeout in milliseconds for the command.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).action.working_directory",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional working directory to run the command in.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).action.env",
  "location": "body",
  "type": "map<string,string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Environment variables to set for the command.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).action.user",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional user to run the command as.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the local shell call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a local shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "local_shell_call_output",
  "schema_ref": "LocalShellToolCallOutput",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "local_shell_call_output"
  ],
  "description": "The type of the local shell tool call output. Always `local_shell_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call_output).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the local shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call_output).output",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the output of the local shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](local_shell_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool representing a request to execute one or more shell commands.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "shell_call",
  "schema_ref": "FunctionShellCallItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "shell_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "shell_call"
  ],
  "description": "The type of the item. Always `shell_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).action",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The shell commands and limits that describe how to run the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "FunctionShellActionParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).action.commands",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ordered shell commands for the execution environment to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).action.timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum wall-clock time in milliseconds to allow the shell commands to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).action.max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of UTF-8 characters to capture from combined stdout and stderr output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).environment",
  "location": "body",
  "type": "object<local> | object<container_reference>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The environment to execute the shell commands in.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).environment(local)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "local",
  "schema_ref": "LocalEnvironmentParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call).environment(container_reference)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "container_reference",
  "schema_ref": "ContainerReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output items emitted by a shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "shell_call_output",
  "schema_ref": "FunctionShellCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call output. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "shell_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "shell_call_output"
  ],
  "description": "The type of the item. Always `shell_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).output",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Captured chunks of stdout and stderr output, along with their associated outcomes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).output[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Captured stdout and stderr for a portion of a shell tool call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "FunctionShellCallOutputContentParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the shell call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](shell_call_output).max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of UTF-8 characters captured for this shell call's combined output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call representing a request to create, delete, or update files using diff patches.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "apply_patch_call",
  "schema_ref": "ApplyPatchToolCallItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "apply_patch_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "apply_patch_call"
  ],
  "description": "The type of the item. Always `apply_patch_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed"
  ],
  "description": "The status of the apply patch tool call. One of `in_progress` or `completed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ApplyPatchCallStatusParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).operation",
  "location": "body",
  "type": "object<create_file> | object<delete_file> | object<update_file>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The specific create, delete, or update instruction for the apply_patch tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ApplyPatchOperationParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).operation(create_file)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Instruction for creating a new file via the apply_patch tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "create_file",
  "schema_ref": "ApplyPatchCreateFileOperationParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).operation(delete_file)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Instruction for deleting an existing file via the apply_patch tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "delete_file",
  "schema_ref": "ApplyPatchDeleteFileOperationParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call).operation(update_file)",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Instruction for updating an existing file via the apply_patch tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "update_file",
  "schema_ref": "ApplyPatchUpdateFileOperationParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output emitted by an apply patch tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "apply_patch_call_output",
  "schema_ref": "ApplyPatchToolCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "apply_patch_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "apply_patch_call_output"
  ],
  "description": "The type of the item. Always `apply_patch_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call output. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call_output).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call_output).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call_output).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "completed",
   "failed"
  ],
  "description": "The status of the apply patch tool call output. One of `completed` or `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ApplyPatchCallOutputStatusParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](apply_patch_call_output).output",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional human-readable log text from the apply patch tool (e.g., patch results or errors).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_list_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools available on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "mcp_list_tools",
  "schema_ref": "MCPListTools",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_list_tools).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_list_tools"
  ],
  "description": "The type of the item. Always `mcp_list_tools`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_list_tools).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the list.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_list_tools).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_list_tools).tools",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tools available on the server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_list_tools).tools[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool available on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "MCPListToolsTool",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_list_tools).error",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Error message if the server could not list tools.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_request)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A request for human approval of a tool invocation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "mcp_approval_request",
  "schema_ref": "MCPApprovalRequest",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_request).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_approval_request"
  ],
  "description": "The type of the item. Always `mcp_approval_request`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_request).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the approval request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_request).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server making the request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_request).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_request).arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of arguments for the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_response)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A response to an MCP approval request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "mcp_approval_response",
  "schema_ref": "MCPApprovalResponse",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_response).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_approval_response"
  ],
  "description": "The type of the item. Always `mcp_approval_response`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_response).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the approval response",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_response).approval_request_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the approval request being answered.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_response).approve",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the request was approved.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_approval_response).reason",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional reason for the decision.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An invocation of a tool on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "mcp_call",
  "schema_ref": "MCPToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_call"
  ],
  "description": "The type of the item. Always `mcp_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server running the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool that was run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the arguments passed to the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).output",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output from the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).error",
  "location": "body",
  "type": "object<mcp_protocol_error> | object<mcp_tool_execution_error> | object<http_error>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The error from the tool call, if any.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).error(mcp_protocol_error)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "mcp_protocol_error",
  "schema_ref": "MCPProtocolError",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).error(mcp_tool_execution_error)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "mcp_tool_execution_error",
  "schema_ref": "MCPToolExecutionError",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).error(http_error)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "http_error",
  "schema_ref": "HTTPError",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete",
   "calling",
   "failed"
  ],
  "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "MCPToolCallStatus",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](mcp_call).approval_request_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the MCP tool call approval request. Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a custom tool call from your code, being sent back to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "custom_tool_call_output",
  "schema_ref": "CustomToolCallOutput",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom_tool_call_output"
  ],
  "description": "The type of the custom tool call output. Always `custom_tool_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call_output).id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the custom tool call output in the OpenAI platform.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The call ID, used to map this custom tool call output to a custom tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call_output).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call_output).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call_output).output",
  "location": "body",
  "type": "string | array<object<input_text> | object<input_image> | object<input_file>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output from the custom tool call generated by your code. Can be a string or an list of output content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call_output).output[]",
  "location": "body",
  "type": "array<object<input_text> | object<input_image> | object<input_file>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or file output of the custom tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A call to a custom tool created by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "custom_tool_call",
  "schema_ref": "CustomToolCall",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom_tool_call"
  ],
  "description": "The type of the custom tool call. Always `custom_tool_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the custom tool call in the OpenAI platform.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An identifier used to map this custom tool call to a tool call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).caller(direct)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "direct",
  "schema_ref": "DirectToolCallCaller",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).caller(program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program",
  "schema_ref": "ProgramToolCallCaller",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).namespace",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace of the custom tool being called.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the custom tool being called.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input for the custom tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](custom_tool_call).async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the custom tool call runs asynchronously.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](compaction_trigger)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Compacts the current context. Must be the final input item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "compaction_trigger",
  "schema_ref": "CompactionTriggerItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](compaction_trigger).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this compaction trigger.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](compaction_trigger).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "compaction_trigger",
  "minimum": null,
  "maximum": null,
  "enum": [
   "compaction_trigger"
  ],
  "description": "The type of the item. Always `compaction_trigger`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](item_reference)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An internal identifier for an item to reference.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "ItemReferenceParam",
  "schema_ref": "ItemReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](item_reference).type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "item_reference",
  "minimum": null,
  "maximum": null,
  "enum": [
   "item_reference"
  ],
  "description": "The type of item to reference. Always `item_reference`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](item_reference).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the item to reference.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program",
  "schema_ref": "ProgramItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "program",
  "minimum": null,
  "maximum": null,
  "enum": [
   "program"
  ],
  "description": "The item type. Always `program`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The stable call ID of the program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program).code",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The JavaScript source executed by programmatic tool calling.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program).fingerprint",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque program replay fingerprint that must be round-tripped.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "program_output",
  "schema_ref": "ProgramOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program_output).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this program output item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "program_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "program_output"
  ],
  "description": "The item type. Always `program_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The call ID of the program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program_output).result",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The result produced by the program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](program_output).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "completed",
   "incomplete"
  ],
  "description": "The terminal status of the program output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ProgramOutputItemStatus",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_text)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "input_text",
  "schema_ref": "InputTextContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text"
  ],
  "description": "The type of the input item. Always `input_text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_image)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "input_image",
  "schema_ref": "InputImageContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_image).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_image",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": "The type of the input item. Always `input_image`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_image).image_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_image).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_image).detail",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "high",
   "auto",
   "original"
  ],
  "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "ImageDetail",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_image).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_image).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_file)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A file input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "variant": "input_file",
  "schema_ref": "InputFileContent",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_file).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_file",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_file"
  ],
  "description": "The type of the input item. Always `input_file`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_file).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_file).filename",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_file).file_data",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_file).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_file).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_file).file_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "items[](message).content[](input_file).detail",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "high"
  ],
  "description": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "schema_ref": "FileInputDetail",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "map<string,string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/methods/update",
  "nullable": true,
  "schema_ref": "Metadata",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/conversations/{conversation_id}/items",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/conversations/{conversation_id}/items",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order to return the input items in. Default is `desc`. - `asc`: Return the input items in ascending order. - `desc`: Return the input items in descending order.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/conversations/{conversation_id}/items",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An item ID to list items after, used in pagination.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/conversations/{conversation_id}/items",
  "parameter": "include",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specify additional output data to include in the model response. Currently supported values are: - `web_search_call.action.sources`: Include the sources of the web search tool call. - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. - `computer_call_output.output.image_url`: Include image urls from the computer call output. - `file_search_call.results`: Include the search results of the file search tool call. - `message.input_image.image_url`: Include image urls from the input message. - `message.output_text.logprobs`: Include logprobs with assistant messages. - `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `fal",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/conversations/{conversation_id}/items",
  "parameter": "include",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional fields to include in the response. See the `include` parameter for [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/create",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/conversations/{conversation_id}/items/{item_id}",
  "parameter": "include",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional fields to include in the response. See the `include` parameter for [listing Conversation items above](https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/list#%28resource%29%20conversations.items%20%3E%20%28method%29%20list%20%3E%20%28params%29%20default%20%3E%20%28param%29%20include%20%3E%20%28schema%29) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/conversations/subresources/items/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-conversations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "input",
  "location": "body",
  "type": "string | string[] | integer[] | integer[][]",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 2048,
  "enum": null,
  "description": "Text(s) or token array(s) to embed. Non-empty; <= 8192 tokens per input; arrays 1-2048 items; <= 300,000 tokens summed per request. Tokenizer cl100k_base.",
  "compatible_models": [
   "text-embedding-3-small",
   "text-embedding-3-large",
   "text-embedding-ada-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/embeddings",
  "notes": "Live: string 'OK' and token array [[11380]] both accepted.",
  "_fragment": "generated/fragments/parameters/openai-embeddings.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text-embedding-3-small",
   "text-embedding-3-large",
   "text-embedding-ada-002"
  ],
  "description": "text-embedding-3-small | text-embedding-3-large | text-embedding-ada-002.",
  "compatible_models": [
   "text-embedding-3-small",
   "text-embedding-3-large",
   "text-embedding-ada-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/embeddings",
  "notes": "Live: ada-002 responds with model 'text-embedding-ada-002-v2'.",
  "_fragment": "generated/fragments/parameters/openai-embeddings.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "dimensions",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 3072,
  "enum": null,
  "description": "Output dimensions (Matryoshka truncation, re-normalized by the API). text-embedding-3-* only; 1..native size (1536 small / 3072 large).",
  "compatible_models": [
   "text-embedding-3-small",
   "text-embedding-3-large"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/embeddings",
  "notes": "Live: dimensions=16 on 3-small -> 16 unit-norm floats; on ada-002 -> 400 'This model does not support specifying dimensions.'",
  "_fragment": "generated/fragments/parameters/openai-embeddings.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "encoding_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "float",
  "minimum": null,
  "maximum": null,
  "enum": [
   "float",
   "base64"
  ],
  "description": "float (default, JSON numbers) | base64 (little-endian float32 bytes, smaller payload).",
  "compatible_models": [
   "text-embedding-3-small",
   "text-embedding-3-large",
   "text-embedding-ada-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/embeddings",
  "notes": "Live: base64 of 16 dims = 64 bytes = 88 base64 chars.",
  "_fragment": "generated/fragments/parameters/openai-embeddings.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "user",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End-user identifier for abuse monitoring.",
  "compatible_models": [
   "text-embedding-3-small",
   "text-embedding-3-large",
   "text-embedding-ada-002"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/embeddings",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-embeddings.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last eval from the previous pagination request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of evals to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals",
  "parameter": "order_by",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "created_at",
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at",
   "updated_at"
  ],
  "description": "Evals can be ordered by creation time or last updated time. Use\n`created_at` for creation time or `updated_at` for last updated time.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: Metadata]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "data_source_config",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The configuration for the data source used for the evaluation runs. Dictates the schema of the data used in the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "data_source_config.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "stored_completions",
  "minimum": null,
  "maximum": null,
  "enum": [
   "stored_completions"
  ],
  "description": "The type of data source. Always `stored_completions`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "data_source_config.item_schema",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The json schema for each row in the data source.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "data_source_config.include_sample_schema",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the eval should expect you to populate the sample namespace (ie, by generating responses off of your data source)",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "data_source_config.metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata filters for the logs data source.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "score_model"
  ],
  "description": "The object type, which is always `score_model`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the grader.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for the evaluation. Must support structured outputs.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].input",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].input[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The role of the message (e.g. \"system\", \"assistant\", \"user\").",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].input[].content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content of the message.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].labels",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The labels to classify to each item in the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].passing_labels",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The labels that indicate a passing result. Must be a subset of labels.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].reference",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The reference text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].operation",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "like",
   "ilike"
  ],
  "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].evaluation_metric",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "cosine",
   "fuzzy_match",
   "bleu",
   "gleu",
   "meteor",
   "rouge_1",
   "rouge_2",
   "rouge_3",
   "rouge_4",
   "rouge_5",
   "rouge_l"
  ],
  "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].pass_threshold",
  "location": "body",
  "type": "number",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The threshold for the score.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].source",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The source code of the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].image_tag",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image tag to use for the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].sampling_params",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The sampling parameters for the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].sampling_params.seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].sampling_params.top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].sampling_params.temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].sampling_params.max_completions_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].sampling_params.reasoning_effort",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: ReasoningEffort]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].input",
  "location": "body",
  "type": "array<EvalItem>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals",
  "parameter": "testing_criteria[].range",
  "location": "body",
  "type": "array<number>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The range of the score. Defaults to `[0, 1]`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Rename the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: Metadata]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/evals/{eval_id}",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation to retrieve runs for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last run from the previous pagination request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of runs to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs",
  "parameter": "status",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "queued",
   "in_progress",
   "completed",
   "canceled",
   "failed"
  ],
  "description": "Filter runs by status. One of `queued` | `in_progress` | `failed` | `completed` | `canceled`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation to create a run for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the run.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: Metadata]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Details about the run's data source.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "responses",
  "minimum": null,
  "maximum": null,
  "enum": [
   "responses"
  ],
  "description": "The type of run data source. Always `responses`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source",
  "location": "body",
  "type": "object | object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Determines what populates the `item` namespace in the data source.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "responses"
  ],
  "description": "The type of run data source. Always `responses`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.content",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content of the jsonl file.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.content[].item",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.content[].sample",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the file.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.input_messages",
  "location": "body",
  "type": "object | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, `item.input_trajectory`), or a template with variable references to the `item` namespace.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.input_messages.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "item_reference"
  ],
  "description": "The type of input messages. Always `item_reference`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.input_messages.template",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.input_messages.item_reference",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A reference to a variable in the `item` namespace. Ie, \"item.input_trajectory\"",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.reasoning_effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: ReasoningEffort]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A higher temperature increases randomness in the outputs.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.max_completion_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of tokens in the generated output.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.top_p",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An alternative to temperature for nucleus sampling; 1.0 includes all tokens.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.seed",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 42,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A seed value to initialize the randomness, during sampling.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.response_format",
  "location": "body",
  "type": "object | object | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models that support it.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.response_format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_object"
  ],
  "description": "The type of response format being defined. Always `json_object`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.response_format.json_schema",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Structured Outputs configuration options, including a JSON Schema.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.response_format.json_schema.description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.response_format.json_schema.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.response_format.json_schema.schema",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: ResponseFormatJsonSchemaSchema]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.response_format.json_schema.strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.tools",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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. A max of 128 functions are supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": "The type of the tool. Currently, only `function` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.tools[].function",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: FunctionObject]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the model to use for generating completions (e.g. \"o3-mini\").",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source",
  "location": "body",
  "type": "object | object | object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Determines what populates the `item` namespace in this run's data source.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: Metadata]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.model",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.created_after",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.created_before",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.limit",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.input_messages.template[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The role of the message (e.g. \"system\", \"assistant\", \"user\").",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.input_messages.template[].content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content of the message.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.tools",
  "location": "body",
  "type": "array<Tool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nThe two categories of tools you can provide the model are:\n\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n  model's capabilities, like [web search](https://developers.openai.com/api/docs/guides/tools-web-search)\n  or [file search](https://developers.openai.com/api/docs/guides/tools-file-search). Learn more about\n  [built-in tools](https://developers.openai.com/api/docs/guides/tools).\n- **Function calls (custom tools)**: Functions",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.text",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.sampling_params.text.format",
  "location": "body",
  "type": "ResponseFormatText | TextResponseFormatJsonSchema | ResponseFormatJsonObject",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs,\nwhich ensures the model will match your supplied JSON schema. Learn more in the\n[Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).\n\nThe default format is `{ \"type\": \"text\" }` with no additional options.\n\n**Not recommended for gpt-4o and newer models:**\n\nSetting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which\nensures the message the model generates is valid JSON. Using `json_schema`\nis preferred for models t [schema: TextResponseFormatConfiguration]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.instructions_search",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.reasoning_effort",
  "location": "body",
  "type": "ReasoningEffort | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.users",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs",
  "parameter": "data_source.source.tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation to retrieve runs for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs/{run_id}",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation whose run you want to cancel.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/evals/{eval_id}/runs/{run_id}",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run to cancel.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/evals/{eval_id}/runs/{run_id}",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation to delete the run from.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/evals/{eval_id}/runs/{run_id}",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}/output_items",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation to retrieve runs for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}/output_items",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run to retrieve output items for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}/output_items",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last output item from the previous pagination request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}/output_items",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of output items to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}/output_items",
  "parameter": "status",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "fail",
   "pass"
  ],
  "description": "Filter output items by status. Use `failed` to filter by failed output\nitems or `pass` to filter by passed output items.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}/output_items",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order for output items by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}",
  "parameter": "eval_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the evaluation to retrieve runs for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}",
  "parameter": "run_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the run to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}",
  "parameter": "output_item_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the output item to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/evals",
  "_fragment": "generated/fragments/parameters/openai-evals.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/files",
  "parameter": "purpose",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only return files with the given purpose.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/files",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 10000,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/files",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/files",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/files",
  "parameter": "file",
  "location": "body(multipart)",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The File object (not file name) to be uploaded.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/files",
  "parameter": "purpose",
  "location": "body(multipart)",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "assistants",
   "batch",
   "fine-tune",
   "vision",
   "user_data",
   "evals"
  ],
  "description": "Intended purpose. `evals` is accepted by the API (used by the Evals guide) although the OpenAPI enum only lists assistants|batch|fine-tune|vision|user_data|evals; response-side purposes also include assistants_output, batch_output, fine-tune-results. Files with purpose=batch expire after 30 days by default.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files/methods/create",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/files",
  "parameter": "expires_after",
  "location": "body(multipart)",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The expiration policy for a file. By default, files with `purpose=batch` expire after 30 days and all other files are persisted until they are manually deleted. [schema: FileExpirationAfter]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/files",
  "parameter": "expires_after.anchor",
  "location": "body(multipart)",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at"
  ],
  "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/files",
  "parameter": "expires_after.seconds",
  "location": "body(multipart)",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 3600,
  "maximum": 2592000,
  "enum": null,
  "description": "The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to use for this request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to use for this request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/files/{file_id}/content",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to use for this request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/files",
  "parameter": "file",
  "location": "body(multipart)",
  "type": "binary",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File bytes (multipart field). Max 512 MB per file; project storage cap 2.5 TB; upload endpoint rate limit 1,000 req/min per user. Batch inputs must be .jsonl <= 200 MB; fine-tune inputs must be .jsonl; vector-store ingestion needs a supported MIME type and <= 5M tokens/file.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/files/methods/create",
  "_fragment": "generated/fragments/parameters/openai-files.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions",
  "parameter": "fine_tuned_model_checkpoint",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuned model checkpoint to get permissions for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions",
  "parameter": "project_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the project to get permissions for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last permission ID from the previous pagination request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 10,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of permissions to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "descending",
  "minimum": null,
  "maximum": null,
  "enum": [
   "ascending",
   "descending"
  ],
  "description": "The order in which to retrieve permissions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions",
  "parameter": "fine_tuned_model_checkpoint",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuned model checkpoint to create a permission for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions",
  "parameter": "project_ids",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The project identifiers to grant access to.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}",
  "parameter": "fine_tuned_model_checkpoint",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuned model checkpoint to delete a permission for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}",
  "parameter": "permission_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuned model checkpoint permission to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "model",
  "location": "body",
  "type": "string | string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the model to fine-tune. You can select one of the\n[supported models](https://developers.openai.com/api/docs/guides/model-optimization#fine-tuning-methods).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "training_file",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of an uploaded file that contains training data.\n\nSee [upload file](https://developers.openai.com/api/reference/resources/files/methods/create) for how to upload a file.\n\nYour dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose `fine-tune`.\n\nThe contents of the file should differ depending on if the model uses the [chat](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data), [completions](https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data) format, or if the fine-tu",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "hyperparameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The hyperparameters used for the fine-tuning job.\nThis value is now deprecated in favor of `method`, and should be passed in under the `method` parameter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "hyperparameters.batch_size",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of examples in each batch. A larger batch size means that model parameters\nare updated less frequently, but with lower variance.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "hyperparameters.learning_rate_multiplier",
  "location": "body",
  "type": "string | number",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid\noverfitting.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "hyperparameters.n_epochs",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of epochs to train the model for. An epoch refers to one full cycle\nthrough the training dataset.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "suffix",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A string of up to 64 characters that will be added to your fine-tuned model name.\n\nFor example, a `suffix` of \"custom-model-name\" would produce a model name like `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "validation_file",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of an uploaded file that contains validation data.\n\nIf you provide this file, the data is used to generate validation\nmetrics periodically during fine-tuning. These metrics can be viewed in\nthe fine-tuning results file.\nThe same data should not be present in both train and validation files.\n\nYour dataset must be formatted as a JSONL file. You must upload your file with the purpose `fine-tune`.\n\nSee the [fine-tuning guide](https://developers.openai.com/api/docs/guides/model-optimization) for more details.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "integrations",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of integrations to enable for your fine-tuning job.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "integrations[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of integration to enable. Currently, only \"wandb\" (Weights and Biases) is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "integrations[].wandb",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The settings for your integration with Weights and Biases. This payload specifies the project that\nmetrics will be sent to. Optionally, you can set an explicit display name for your run, add tags\nto your run, and set a default entity (team, username, etc) to be associated with your run.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "integrations[].wandb.project",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the project that the new run will be created under.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "integrations[].wandb.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A display name to set for the run. If not set, we will use the Job ID as the name.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "integrations[].wandb.entity",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The entity to use for the run. This allows you to set the team or username of the WandB user that you would\nlike associated with the run. If not set, the default entity for the registered WandB API key is used.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "integrations[].wandb.tags",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some\ndefault tags are generated by OpenAI: \"openai/finetune\", \"openai/{base-model}\", \"openai/{ftjob-abcdef}\".",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "seed",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 2147483647,
  "enum": null,
  "description": "The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases.\nIf a seed is not specified, one will be generated for you.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The method used for fine-tuning. [schema: FineTuneMethod]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "supervised",
   "dpo",
   "reinforcement"
  ],
  "description": "The type of method. Is either `supervised`, `dpo`, or `reinforcement`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.supervised",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for the supervised fine-tuning method. [schema: FineTuneSupervisedMethod]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.supervised.hyperparameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The hyperparameters used for the fine-tuning job. [schema: FineTuneSupervisedHyperparameters]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.supervised.hyperparameters.batch_size",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.supervised.hyperparameters.learning_rate_multiplier",
  "location": "body",
  "type": "string | number",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.supervised.hyperparameters.n_epochs",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.dpo",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for the DPO fine-tuning method. [schema: FineTuneDPOMethod]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.dpo.hyperparameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The hyperparameters used for the DPO fine-tuning job. [schema: FineTuneDPOHyperparameters]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.dpo.hyperparameters.beta",
  "location": "body",
  "type": "string | number",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.dpo.hyperparameters.batch_size",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.dpo.hyperparameters.learning_rate_multiplier",
  "location": "body",
  "type": "string | number",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.dpo.hyperparameters.n_epochs",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for the reinforcement fine-tuning method. [schema: FineTuneReinforcementMethod]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The grader used for the fine-tuning job.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "multi",
  "minimum": null,
  "maximum": null,
  "enum": [
   "multi"
  ],
  "description": "The object type, which is always `multi`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the grader.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.reference",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The reference text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.operation",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "like",
   "ilike"
  ],
  "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.evaluation_metric",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "cosine",
   "fuzzy_match",
   "bleu",
   "gleu",
   "meteor",
   "rouge_1",
   "rouge_2",
   "rouge_3",
   "rouge_4",
   "rouge_5",
   "rouge_l"
  ],
  "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.source",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The source code of the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.image_tag",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image tag to use for the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.sampling_params",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The sampling parameters for the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.sampling_params.seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.sampling_params.top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.sampling_params.temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.sampling_params.max_completions_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.sampling_params.reasoning_effort",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: ReasoningEffort]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.input",
  "location": "body",
  "type": "array<EvalItem>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.range",
  "location": "body",
  "type": "array<number>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The range of the score. Defaults to `[0, 1]`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.graders",
  "location": "body",
  "type": "GraderStringCheck | GraderTextSimilarity | GraderPython | GraderScoreModel | GraderLabelModel",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.grader.calculate_output",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A formula to calculate the output based on grader results.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.hyperparameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The hyperparameters used for the reinforcement fine-tuning job. [schema: FineTuneReinforcementHyperparameters]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.hyperparameters.batch_size",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.hyperparameters.learning_rate_multiplier",
  "location": "body",
  "type": "string | number",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.hyperparameters.n_epochs",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.hyperparameters.reasoning_effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "default",
  "minimum": null,
  "maximum": null,
  "enum": [
   "default",
   "low",
   "medium",
   "high"
  ],
  "description": "Level of reasoning effort.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.hyperparameters.compute_multiplier",
  "location": "body",
  "type": "string | number",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Multiplier on amount of compute used for exploring search space during training.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.hyperparameters.eval_interval",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of training steps between evaluation runs.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.hyperparameters.eval_samples",
  "location": "body",
  "type": "string | integer",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of evaluation samples to generate per training step.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: Metadata]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last job from the previous pagination request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of fine-tuning jobs to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs",
  "parameter": "metadata",
  "location": "query",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Alternatively, set `metadata=null` to indicate no metadata.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs/{fine_tuning_job_id}",
  "parameter": "fine_tuning_job_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuning job.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel",
  "parameter": "fine_tuning_job_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuning job to cancel.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints",
  "parameter": "fine_tuning_job_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuning job to get checkpoints for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last checkpoint ID from the previous pagination request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 10,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of checkpoints to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs/{fine_tuning_job_id}/events",
  "parameter": "fine_tuning_job_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuning job to get events for.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs/{fine_tuning_job_id}/events",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last event from the previous pagination request.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/fine_tuning/jobs/{fine_tuning_job_id}/events",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of events to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs/{fine_tuning_job_id}/pause",
  "parameter": "fine_tuning_job_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuning job to pause.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs/{fine_tuning_job_id}/resume",
  "parameter": "fine_tuning_job_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the fine-tuning job to resume.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.reinforcement.response_format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Structured-output format applied to samples during RFT training ({type: json_schema, json_schema: {name, strict, schema}}); used by the RFT guide, populates sample.output_json for graders. Present in guide/reference examples; not in the FineTuneReinforcementMethod spec properties.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "method.dpo.hyperparameters.beta",
  "location": "body",
  "type": "number | 'auto'",
  "required": false,
  "default": "auto",
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "description": "DPO only. Float in [0, 2]: higher = more conservative (stick to reference behaviour), lower = follow the preferences more aggressively. Default auto.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/direct-preference-optimization",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/jobs",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Base model or previously fine-tuned model id. Per model pages (2026-09-18) fine-tuning is 'Supported' for: gpt-4.1, gpt-4.1-mini, gpt-4.1-nano, gpt-4o, gpt-4o-mini, o4-mini (RFT), gpt-4, gpt-3.5-turbo (legacy). Guides pin snapshots: SFT/DPO -> gpt-4.1-2025-04-14 / -mini / -nano; vision SFT -> gpt-4o-2024-08-06; RFT -> o4-mini-2025-04-16. No gpt-5.x model supports fine-tuning.",
  "compatible_models": [
   "gpt-4.1-2025-04-14",
   "gpt-4.1-mini-2025-04-14",
   "gpt-4.1-nano-2025-04-14",
   "gpt-4o-2024-08-06",
   "gpt-4o-mini-2024-07-18",
   "o4-mini-2025-04-16",
   "gpt-4",
   "gpt-3.5-turbo"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/model-optimization#fine-tuning-methods",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "training_file (JSONL line, method=supervised)",
  "parameter": "messages[]",
  "location": "file",
  "type": "array<message>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Chat-format example: system/developer, user, assistant, tool messages; assistant messages may carry tool_calls and `weight` (0|1) to exclude a turn from the loss. Optional top-level `tools[]`, `parallel_tool_calls`, `functions[]`(legacy). Min 10 lines.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/supervised-fine-tuning#formatting-your-data",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "training_file (JSONL line, method=supervised)",
  "parameter": "messages[].weight",
  "location": "file",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   0,
   1
  ],
  "description": "Assistant messages only. 0 = do not train on this message, 1 = train (default).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/fine_tuning",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "training_file (JSONL line, method=dpo)",
  "parameter": "input.messages[]",
  "location": "file",
  "type": "array<message>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Prompt messages (one-turn conversations only). Optional input.tools[], input.parallel_tool_calls.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/direct-preference-optimization#data-format",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "training_file (JSONL line, method=dpo)",
  "parameter": "preferred_output[]",
  "location": "file",
  "type": "array<assistant message>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ideal assistant response (must be the last assistant message).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/direct-preference-optimization#data-format",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "training_file (JSONL line, method=dpo)",
  "parameter": "non_preferred_output[]",
  "location": "file",
  "type": "array<assistant message>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Suboptimal assistant response.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/direct-preference-optimization#data-format",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "training_file (JSONL line, method=reinforcement)",
  "parameter": "messages[]",
  "location": "file",
  "type": "array<message>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Prompt messages; every other top-level key of the line is exposed to the grader as `item.<key>` (e.g. reference_answer). No assistant answer is required.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/reinforcement-fine-tuning#prepare-your-dataset",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "training_file (JSONL line, vision SFT)",
  "parameter": "messages[].content[].image_url",
  "location": "file",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image inputs as HTTP URL or data URL; JPEG/PNG/WEBP, RGB/RGBA, <= 10 MB each, <= 10 images per example, <= 50,000 image examples per file; `detail: low` -> 85 tokens/image. No images in assistant messages.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/vision-fine-tuning#image-data-requirements",
  "_fragment": "generated/fragments/parameters/openai-fine-tuning.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The grader used for the fine-tuning job.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "multi",
  "minimum": null,
  "maximum": null,
  "enum": [
   "multi"
  ],
  "description": "The object type, which is always `multi`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the grader.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.reference",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The reference text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.operation",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "like",
   "ilike"
  ],
  "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.evaluation_metric",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "cosine",
   "fuzzy_match",
   "bleu",
   "gleu",
   "meteor",
   "rouge_1",
   "rouge_2",
   "rouge_3",
   "rouge_4",
   "rouge_5",
   "rouge_l"
  ],
  "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.source",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The source code of the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.image_tag",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image tag to use for the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.sampling_params",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The sampling parameters for the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.sampling_params.seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.sampling_params.top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.sampling_params.temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.sampling_params.max_completions_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.sampling_params.reasoning_effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: ReasoningEffort]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.input",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.input[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant",
   "system",
   "developer"
  ],
  "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.input[].content",
  "location": "body",
  "type": "EvalItemContentItem | EvalItemContentArray",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items. [schema: EvalItemContent]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.input[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "message"
  ],
  "description": "The type of the message input. Always `message`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.range",
  "location": "body",
  "type": "array<number>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The range of the score. Defaults to `[0, 1]`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders",
  "location": "body",
  "type": "object | object | object | object | object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "label_model"
  ],
  "description": "The object type, which is always `label_model`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the grader.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.reference",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The reference text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.operation",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "like",
   "ilike"
  ],
  "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.evaluation_metric",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "cosine",
   "fuzzy_match",
   "bleu",
   "gleu",
   "meteor",
   "rouge_1",
   "rouge_2",
   "rouge_3",
   "rouge_4",
   "rouge_5",
   "rouge_l"
  ],
  "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.source",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The source code of the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.image_tag",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image tag to use for the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.sampling_params",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The sampling parameters for the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.sampling_params.seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.sampling_params.top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.sampling_params.temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.sampling_params.max_completions_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.sampling_params.reasoning_effort",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: ReasoningEffort]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.input",
  "location": "body",
  "type": "array<EvalItem>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.range",
  "location": "body",
  "type": "array<number>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The range of the score. Defaults to `[0, 1]`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.labels",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The labels to assign to each item in the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.graders.passing_labels",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The labels that indicate a passing result. Must be a subset of labels.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "grader.calculate_output",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A formula to calculate the output based on grader results.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "item",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The dataset item provided to the grader. This will be used to populate\nthe `item` namespace. See [the guide](https://developers.openai.com/api/docs/guides/graders) for more details.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/run",
  "parameter": "model_sample",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model sample to be evaluated. This value will be used to populate\nthe `sample` namespace. See [the guide](https://developers.openai.com/api/docs/guides/graders) for more details.\nThe `output_json` variable will be populated if the model sample is a\nvalid JSON string.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The grader used for the fine-tuning job.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "multi",
  "minimum": null,
  "maximum": null,
  "enum": [
   "multi"
  ],
  "description": "The object type, which is always `multi`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the grader.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.reference",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The reference text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.operation",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "like",
   "ilike"
  ],
  "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.evaluation_metric",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "cosine",
   "fuzzy_match",
   "bleu",
   "gleu",
   "meteor",
   "rouge_1",
   "rouge_2",
   "rouge_3",
   "rouge_4",
   "rouge_5",
   "rouge_l"
  ],
  "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.source",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The source code of the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.image_tag",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image tag to use for the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.sampling_params",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The sampling parameters for the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.sampling_params.seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.sampling_params.top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.sampling_params.temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.sampling_params.max_completions_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.sampling_params.reasoning_effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: ReasoningEffort]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.input",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.input[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant",
   "system",
   "developer"
  ],
  "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.input[].content",
  "location": "body",
  "type": "EvalItemContentItem | EvalItemContentArray",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items. [schema: EvalItemContent]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.input[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "message"
  ],
  "description": "The type of the message input. Always `message`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.range",
  "location": "body",
  "type": "array<number>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The range of the score. Defaults to `[0, 1]`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders",
  "location": "body",
  "type": "object | object | object | object | object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "label_model"
  ],
  "description": "The object type, which is always `label_model`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the grader.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.reference",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The reference text. This may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.operation",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "like",
   "ilike"
  ],
  "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.evaluation_metric",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "cosine",
   "fuzzy_match",
   "bleu",
   "gleu",
   "meteor",
   "rouge_1",
   "rouge_2",
   "rouge_3",
   "rouge_4",
   "rouge_5",
   "rouge_l"
  ],
  "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.source",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The source code of the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.image_tag",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image tag to use for the python script.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.sampling_params",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The sampling parameters for the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.sampling_params.seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.sampling_params.top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.sampling_params.temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.sampling_params.max_completions_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.sampling_params.reasoning_effort",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: ReasoningEffort]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.input",
  "location": "body",
  "type": "array<EvalItem>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.range",
  "location": "body",
  "type": "array<number>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The range of the score. Defaults to `[0, 1]`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.labels",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The labels to assign to each item in the evaluation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.graders.passing_labels",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The labels that indicate a passing result. Must be a subset of labels.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/fine_tuning/alpha/graders/validate",
  "parameter": "grader.calculate_output",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A formula to calculate the output based on grader results.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/graders",
  "_fragment": "generated/fragments/parameters/openai-graders.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text description. Max 32000 chars for GPT image models, 1000 for dall-e-2, 4000 for dall-e-3.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2",
   "dall-e-3"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "dall-e-2 (documented; effectively required)",
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2",
   "dall-e-3"
  ],
  "description": "Image model id. Docs: defaults to dall-e-2 unless a GPT-image-only parameter is present; DALL-E removed 2026-05-12 so always set it.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2",
   "dall-e-3"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": "Live: dall-e-3 -> 400 \"The model 'dall-e-3' does not exist.\" chatgpt-image-latest is in the edits enum and its model page lists generations as supported.",
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "n",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 1,
  "minimum": 1,
  "maximum": 10,
  "enum": null,
  "description": "Number of images. 1-10; dall-e-3 only n=1.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2",
   "dall-e-3"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "quality",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "medium",
   "high",
   "xhigh",
   "max",
   "standard",
   "hd"
  ],
  "description": "auto (default) | low | medium | high (GPT image) | xhigh, max (gpt-image-2.5 only) | standard, hd (dall-e-3) | standard (dall-e-2).",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2",
   "dall-e-3"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": "Live: quality=low accepted by gpt-image-1-mini and echoed in the response.",
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "size",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto (spec) / 1024x1024 (edits spec)",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "1024x1024",
   "1536x1024",
   "1024x1536",
   "256x256",
   "512x512",
   "1792x1024",
   "1024x1792",
   "WIDTHxHEIGHT (gpt-image-2/2.5)"
  ],
  "description": "WIDTHxHEIGHT. gpt-image-2 / 2.5 accept arbitrary sizes: both edges multiples of 16, aspect ratio between 1:3 and 3:1, max edge 3840, total pixels 655,360-8,294,400; above 2560x1440 is experimental. Other GPT image models: 1024x1024, 1536x1024, 1024x1536, auto. dall-e-2: 256x256, 512x512, 1024x1024. dall-e-3: 1024x1024, 1792x1024, 1024x1792.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2",
   "dall-e-3"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": "Live gpt-image-1-mini size=123x456 -> 400 image_generation_user_error param=size code=invalid_value 'Supported sizes are 1024x1024, 1024x1536, 1536x1024, and auto.'",
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "background",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "transparent",
   "opaque",
   "auto"
  ],
  "description": "transparent | opaque | auto (default). GPT image models only. gpt-image-2.5 fully supports transparent; gpt-image-2 transparent is PREVIEW. With transparent use output_format png or webp.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": "Response echoes background ('opaque' observed live).",
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "output_format",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "png",
  "minimum": null,
  "maximum": null,
  "enum": [
   "png",
   "jpeg",
   "webp"
  ],
  "description": "png (default) | jpeg | webp. GPT image models only (DALL-E used response_format).",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "output_compression",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 100,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "Compression 0-100 for jpeg/webp output. GPT image models only.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "moderation",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "auto"
  ],
  "description": "Content-moderation strictness: auto (default) or low (less restrictive). GPT image models only.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "stream",
  "location": "body",
  "type": "boolean|null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stream partial images as SSE events (image_generation.partial_image / .completed). GPT image models only.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "partial_images",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 0,
  "minimum": 0,
  "maximum": 3,
  "enum": null,
  "description": "Number of partial images to emit while streaming (0-3). 0 = final image only in one event. Each partial image costs +100 image output tokens.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "response_format",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "url",
  "minimum": null,
  "maximum": null,
  "enum": [
   "url",
   "b64_json"
  ],
  "description": "url | b64_json. dall-e-2/3 only (URLs valid 60 min). GPT image models always return b64_json.",
  "compatible_models": [
   "dall-e-2",
   "dall-e-3"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": "Live: on gpt-image-1-mini -> 400 unknown_parameter param=response_format.",
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "style",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "vivid",
  "minimum": null,
  "maximum": null,
  "enum": [
   "vivid",
   "natural"
  ],
  "description": "vivid (default) | natural. dall-e-3 only.",
  "compatible_models": [
   "dall-e-3"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": "Live: on gpt-image-1-mini -> 400 unknown_parameter param=style.",
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "user",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stable end-user identifier for abuse monitoring (see safety identifiers).",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2",
   "dall-e-3"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "image",
  "location": "body",
  "type": "file | file[] (multipart)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": 16,
  "enum": null,
  "description": "Image(s) to edit, multipart field `image` or repeated `image[]`. GPT image models: up to 16 images, each png/webp/jpg < 50 MB. dall-e-2: one square PNG < 4 MB.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": "Required in the OpenAPI multipart schema (with prompt).",
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "images",
  "location": "body",
  "type": "array<{file_id?, image_url?}> (JSON)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 16,
  "enum": null,
  "description": "JSON-body alternative to multipart `image`: up to 16 references, each with exactly one of file_id (Files API) or image_url (URL or base64 data URL).",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Desired edit. Max 32000 chars (GPT image), 1000 (dall-e-2).",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "mask",
  "location": "body",
  "type": "file (multipart) | {file_id?, image_url?} (JSON)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "PNG whose fully transparent pixels (alpha 0) mark the area to edit; applied to the first image; must have an alpha channel and the same size/format as the image. Masking with GPT Image is prompt-guided (not pixel-exact).",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "model",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "gpt-image-1.5",
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2"
  ],
  "description": "Edit model. Spec default gpt-image-1.5.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "input_fidelity",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "low",
  "minimum": null,
  "maximum": null,
  "enum": [
   "high",
   "low"
  ],
  "description": "high | low (default). How strongly input details (esp. faces) are preserved. Supported for gpt-image-1, gpt-image-1.5 and later; NOT gpt-image-1-mini; gpt-image-2 always uses high (parameter rejected/ignored).",
  "compatible_models": [
   "gpt-image-1",
   "gpt-image-1.5",
   "chatgpt-image-latest",
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-flare"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": "Changelog: a bug made gpt-image-1.5/chatgpt-image-latest use high fidelity even with low; fixed.",
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "background",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "transparent",
   "opaque",
   "auto"
  ],
  "description": "transparent | opaque | auto. GPT image models only (gpt-image-2 transparent = preview).",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "quality",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "medium",
   "high",
   "xhigh",
   "max",
   "standard"
  ],
  "description": "auto | low | medium | high; xhigh, max for gpt-image-2.5; standard for dall-e-2.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "size",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "1024x1024",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "1024x1024",
   "1536x1024",
   "1024x1536",
   "256x256",
   "512x512",
   "WIDTHxHEIGHT (gpt-image-2/2.5)"
  ],
  "description": "WIDTHxHEIGHT. gpt-image-2 / 2.5 accept arbitrary sizes: both edges multiples of 16, aspect ratio between 1:3 and 3:1, max edge 3840, total pixels 655,360-8,294,400; above 2560x1440 is experimental. Other GPT image models: 1024x1024, 1536x1024, 1024x1536, auto. dall-e-2: 256x256, 512x512, 1024x1024. dall-e-3: 1024x1024, 1792x1024, 1024x1792. Edits spec default 1024x1024.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "n",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 1,
  "minimum": 1,
  "maximum": 10,
  "enum": null,
  "description": "1-10 edited images.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "moderation",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "auto"
  ],
  "description": "low | auto. GPT image models.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "output_format",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "png",
  "minimum": null,
  "maximum": null,
  "enum": [
   "png",
   "jpeg",
   "webp"
  ],
  "description": "png | jpeg | webp (GPT image models).",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "output_compression",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 100,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "0-100 for jpeg/webp.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "response_format",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "url",
  "minimum": null,
  "maximum": null,
  "enum": [
   "url",
   "b64_json"
  ],
  "description": "url | b64_json, dall-e-2 only.",
  "compatible_models": [
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "stream",
  "location": "body",
  "type": "boolean|null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stream image_edit.partial_image / image_edit.completed events.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "partial_images",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 0,
  "minimum": 0,
  "maximum": 3,
  "enum": null,
  "description": "0-3 partial images while streaming (+100 output tokens each).",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "user",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End-user identifier.",
  "compatible_models": [
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-1.5",
   "gpt-image-1",
   "gpt-image-1-mini",
   "chatgpt-image-latest",
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/variations",
  "parameter": "image",
  "location": "body",
  "type": "file (multipart)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Square PNG < 4 MB.",
  "compatible_models": [
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/variations",
  "parameter": "model",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "dall-e-2",
  "minimum": null,
  "maximum": null,
  "enum": [
   "dall-e-2"
  ],
  "description": "Only dall-e-2.",
  "compatible_models": [
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/variations",
  "parameter": "n",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 1,
  "minimum": 1,
  "maximum": 10,
  "enum": null,
  "description": "1-10.",
  "compatible_models": [
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/variations",
  "parameter": "response_format",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "url",
  "minimum": null,
  "maximum": null,
  "enum": [
   "url",
   "b64_json"
  ],
  "description": "url | b64_json.",
  "compatible_models": [
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/variations",
  "parameter": "size",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "1024x1024",
  "minimum": null,
  "maximum": null,
  "enum": [
   "256x256",
   "512x512",
   "1024x1024"
  ],
  "description": "256x256 | 512x512 | 1024x1024.",
  "compatible_models": [
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": "Live 2026-09-18: whole endpoint returns 404 with empty body.",
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/images/variations",
  "parameter": "user",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End-user identifier.",
  "compatible_models": [
   "dall-e-2"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-images.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Startup configuration for a Live media session. Follow the [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting) when writing frontend instructions and the backend prompt under delegation.responses.instructions.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-live-1"
  ],
  "nullable": false,
  "description": "The Live model. Required in the session configuration for every transport; do not pass it as a URL query parameter.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Startup audio output configuration. WebRTC and SIP negotiate the media format; audio.format is only accepted for primary WebSockets. Voice cannot change after startup.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Settings for speech generated by the Live model. Choose the voice before starting the session.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.audio.output.voice",
  "location": "body",
  "type": "object | LiveCustomVoiceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.audio.output.voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveCustomVoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "client",
  "minimum": null,
  "maximum": null,
  "enum": [
   "client",
   "responses"
  ],
  "nullable": false,
  "description": "The delegation owner. Always `client` for tasks handled by your application.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveClientDelegationParam | LiveResponsesDelegationParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Model, prompt, and tool settings for tasks delegated by the Live session to a Responses backend.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveResponsesDelegationParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The model used for server-owned Responses delegations.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.max_output_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.service_tier",
  "location": "body",
  "type": "LiveResponsesServiceTier | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "fast_tier_temp_pilot",
   "flex",
   "priority",
   "ultrafast"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.reasoning",
  "location": "body",
  "type": "LiveDelegationReasoningInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.reasoning.effort",
  "location": "body",
  "type": "LiveReasoningEffort | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.reasoning.summary",
  "location": "body",
  "type": "LiveReasoningSummary | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "concise",
   "detailed",
   "auto"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.text",
  "location": "body",
  "type": "LiveDelegationTextInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.text.verbosity",
  "location": "body",
  "type": "LiveTextVerbosity | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationTextInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tools",
  "location": "body",
  "type": "array<LiveFunctionToolInputParam | LiveWebSearchToolInputParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the Responses backend while it handles tasks delegated by the Live model.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "web_search"
  ],
  "nullable": false,
  "description": "The tool type. Always `function`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam | LiveWebSearchToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name the delegated Responses model uses when calling this function.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tools[].parameters",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tools[].strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tool_choice",
  "location": "body",
  "type": "LiveToolChoiceEnum | LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "none",
   "required"
  ],
  "nullable": false,
  "description": "Controls which tool the Responses backend uses when handling a task delegated by the Live model.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.delegation.responses.parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.store",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether to store the session for later forking and recording download. Defaults to false for new sessions.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.input",
  "location": "body",
  "type": "array<LiveInitialItem>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Ordered text-only history supplied before startup. Supports developer, user, and assistant messages with one text part each; at most 128 messages and 8,192 rendered tokens in total.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.input[].id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.input[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "message",
  "minimum": null,
  "maximum": null,
  "enum": [
   "message"
  ],
  "nullable": false,
  "description": "The history item type. Always `message`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.input[].status",
  "location": "body",
  "type": "LiveInitialMessageStatus | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "incomplete",
   "completed"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.input[].role",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "developer",
  "minimum": null,
  "maximum": null,
  "enum": [
   "developer",
   "user",
   "assistant"
  ],
  "nullable": false,
  "description": "The author of this history message. Always `developer`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.input[].content",
  "location": "body",
  "type": "array<LiveInitialInputTextContentPartParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The message content. Supply exactly one text part for the initial Live conversation history.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.input[].content[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "input_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text",
   "text",
   "output_text"
  ],
  "nullable": false,
  "description": "The text content type. Always `input_text`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.input[].content[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The message text to include in the Live session’s initial conversation history.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.client",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Startup-only capabilities for an untrusted frontend attached to a unified WebRTC session. Trusted sideband connections are unaffected.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.client.data_channel",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Control which Live events an untrusted WebRTC frontend can send and receive over its data channel. These restrictions do not apply to trusted sideband connections.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.client.data_channel.allowed_client_events",
  "location": "body",
  "type": "enum | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "all"
  ],
  "nullable": false,
  "description": "Client event types that the frontend data channel may send. Use 'all' to allow every client event; an empty array allows none. Omission preserves the existing allow-all behavior.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "session.client.data_channel.allowed_server_events",
  "location": "body",
  "type": "enum | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "all"
  ],
  "nullable": false,
  "description": "Server events that may be sent to the frontend data channel. Use 'all' to allow every server event; an empty array allows none. Omission preserves the existing allow-all behavior. Responses events use an object with type 'response.event' and a response_event selector.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "transport",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "WebRTC transport carrying the offer SDP in a creation request or answer SDP in its response.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "transport.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "webrtc"
  ],
  "nullable": false,
  "description": "The transport used for the Live session. Always `webrtc`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions",
  "parameter": "transport.sdp",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Session Description Protocol message for the WebRTC connection.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional overrides for a stored Live session. Omitted settings are inherited. The model, voice, frontend instructions, and prior conversation come from the stored session. WebRTC negotiates its audio format; audio.format is only supported on WebSocket forks.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.store",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether to store the forked session. Omission inherits the stored session's setting.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Update the Responses backend for an existing Live session without changing delegation ownership.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "responses",
  "minimum": null,
  "maximum": null,
  "enum": [
   "responses"
  ],
  "nullable": false,
  "description": "The delegation owner. Always `responses` for tasks handled by the Responses API.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Updates to the Responses backend of an existing Live session. Omitted settings retain their current values.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Responses backend model to use for subsequent delegated requests. Omit to keep the current backend model.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.max_output_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.service_tier",
  "location": "body",
  "type": "LiveResponsesServiceTier | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "fast_tier_temp_pilot",
   "flex",
   "priority",
   "ultrafast"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.reasoning",
  "location": "body",
  "type": "LiveDelegationReasoningInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.reasoning.effort",
  "location": "body",
  "type": "LiveReasoningEffort | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.reasoning.summary",
  "location": "body",
  "type": "LiveReasoningSummary | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "concise",
   "detailed",
   "auto"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.text",
  "location": "body",
  "type": "LiveDelegationTextInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.text.verbosity",
  "location": "body",
  "type": "LiveTextVerbosity | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationTextInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tools",
  "location": "body",
  "type": "array<LiveFunctionToolInputParam | LiveWebSearchToolInputParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the Responses backend while it handles tasks delegated by the Live model.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "web_search"
  ],
  "nullable": false,
  "description": "The tool type. Always `function`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam | LiveWebSearchToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name the delegated Responses model uses when calling this function.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tools[].parameters",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tools[].strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tool_choice",
  "location": "body",
  "type": "LiveToolChoiceEnum | LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "none",
   "required"
  ],
  "nullable": false,
  "description": "Controls which tool the Responses backend uses when handling a task delegated by the Live model.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.delegation.responses.parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.client",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Startup-only capabilities for an untrusted frontend attached to a unified WebRTC session. Trusted sideband connections are unaffected.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.client.data_channel",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Control which Live events an untrusted WebRTC frontend can send and receive over its data channel. These restrictions do not apply to trusted sideband connections.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.client.data_channel.allowed_client_events",
  "location": "body",
  "type": "enum | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "all"
  ],
  "nullable": false,
  "description": "Client event types that the frontend data channel may send. Use 'all' to allow every client event; an empty array allows none. Omission preserves the existing allow-all behavior.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session.client.data_channel.allowed_server_events",
  "location": "body",
  "type": "enum | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "all"
  ],
  "nullable": false,
  "description": "Server events that may be sent to the frontend data channel. Use 'all' to allow every server event; an empty array allows none. Omission preserves the existing allow-all behavior. Responses events use an object with type 'response.event' and a response_event selector.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "transport",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "WebRTC transport carrying the offer SDP in a creation request or answer SDP in its response.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "transport.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "webrtc"
  ],
  "nullable": false,
  "description": "The transport used for the Live session. Always `webrtc`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "transport.sdp",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Session Description Protocol message for the WebRTC connection.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/fork",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter: stored source session to fork.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/fork",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Startup configuration for accepting an incoming Live SIP call. Follow the [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting) when writing frontend and backend instructions.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-live-1"
  ],
  "nullable": false,
  "description": "The Live model. Required in the session configuration for every transport; do not pass it as a URL query parameter.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Startup audio output configuration. WebRTC and SIP negotiate the media format; audio.format is only accepted for primary WebSockets. Voice cannot change after startup.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Settings for speech generated by the Live model. Choose the voice before starting the session.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.audio.output.voice",
  "location": "body",
  "type": "object | LiveCustomVoiceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.audio.output.voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveCustomVoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "client",
  "minimum": null,
  "maximum": null,
  "enum": [
   "client",
   "responses"
  ],
  "nullable": false,
  "description": "The delegation owner. Always `client` for tasks handled by your application.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveClientDelegationParam | LiveResponsesDelegationParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Model, prompt, and tool settings for tasks delegated by the Live session to a Responses backend.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveResponsesDelegationParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The model used for server-owned Responses delegations.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.max_output_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.service_tier",
  "location": "body",
  "type": "LiveResponsesServiceTier | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "fast_tier_temp_pilot",
   "flex",
   "priority",
   "ultrafast"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.reasoning",
  "location": "body",
  "type": "LiveDelegationReasoningInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.reasoning.effort",
  "location": "body",
  "type": "LiveReasoningEffort | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.reasoning.summary",
  "location": "body",
  "type": "LiveReasoningSummary | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "concise",
   "detailed",
   "auto"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.text",
  "location": "body",
  "type": "LiveDelegationTextInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.text.verbosity",
  "location": "body",
  "type": "LiveTextVerbosity | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationTextInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tools",
  "location": "body",
  "type": "array<LiveFunctionToolInputParam | LiveWebSearchToolInputParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the Responses backend while it handles tasks delegated by the Live model.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "web_search"
  ],
  "nullable": false,
  "description": "The tool type. Always `function`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam | LiveWebSearchToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name the delegated Responses model uses when calling this function.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tools[].parameters",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tools[].strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tool_choice",
  "location": "body",
  "type": "LiveToolChoiceEnum | LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "none",
   "required"
  ],
  "nullable": false,
  "description": "Controls which tool the Responses backend uses when handling a task delegated by the Live model.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.delegation.responses.parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.store",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether to store the session for later forking and recording download. Defaults to false for new sessions.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.input",
  "location": "body",
  "type": "array<LiveInitialItem>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Ordered text-only history supplied before startup. Supports developer, user, and assistant messages with one text part each; at most 128 messages and 8,192 rendered tokens in total.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.input[].id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.input[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "message",
  "minimum": null,
  "maximum": null,
  "enum": [
   "message"
  ],
  "nullable": false,
  "description": "The history item type. Always `message`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.input[].status",
  "location": "body",
  "type": "LiveInitialMessageStatus | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "incomplete",
   "completed"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.input[].role",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "developer",
  "minimum": null,
  "maximum": null,
  "enum": [
   "developer",
   "user",
   "assistant"
  ],
  "nullable": false,
  "description": "The author of this history message. Always `developer`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.input[].content",
  "location": "body",
  "type": "array<LiveInitialInputTextContentPartParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The message content. Supply exactly one text part for the initial Live conversation history.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.input[].content[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "input_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text",
   "text",
   "output_text"
  ],
  "nullable": false,
  "description": "The text content type. Always `input_text`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.input[].content[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The message text to include in the Live session’s initial conversation history.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "live",
  "minimum": null,
  "maximum": null,
  "enum": [
   "live"
  ],
  "nullable": false,
  "description": "The session type. Always `live`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/accept",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter: `data.session_id` from the `live.transport.incoming` webhook.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/accept",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/refer",
  "parameter": "target_uri",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "URI that should appear in the SIP Refer-To header. Supports values like\n`tel:+14155550123` or `sip:agent@example.com`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/refer",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/refer",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/refer",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/reject",
  "parameter": "status_code",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 300,
  "maximum": 699,
  "enum": null,
  "nullable": false,
  "description": "SIP rejection status sent to the caller. This field is required.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/reject",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/reject",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/reject",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/live/sessions/{session_id}/hangup",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter. No body.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/hangup",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/live/sessions/{session_id}/content",
  "parameter": "session_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter. Returns audio/wav (stereo: left=input, right=output) of a finalized stored session (store=true).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/subresources/sessions/methods/content",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.start",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.start"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.start`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Initial configuration for a Live session, including its model, conversation instructions, audio, and delegated task handling.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-live-1"
  ],
  "nullable": false,
  "description": "The Live model. Required in the session configuration for every transport; do not pass it as a URL query parameter.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.input",
  "location": "body",
  "type": "array<LiveInitialItem>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Ordered text-only history supplied before startup. Supports developer, user, and assistant messages with one text part each; at most 128 messages and 8,192 rendered tokens in total.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.input[].id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.input[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "message",
  "minimum": null,
  "maximum": null,
  "enum": [
   "message"
  ],
  "nullable": false,
  "description": "The history item type. Always `message`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.input[].status",
  "location": "body",
  "type": "LiveInitialMessageStatus | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "incomplete",
   "completed"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.input[].role",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "developer",
  "minimum": null,
  "maximum": null,
  "enum": [
   "developer",
   "user",
   "assistant"
  ],
  "nullable": false,
  "description": "The author of this history message. Always `developer`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.input[].content",
  "location": "body",
  "type": "array<LiveInitialInputTextContentPartParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The message content. Supply exactly one text part for the initial Live conversation history.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveInitialDeveloperMessageItemParam | LiveInitialUserMessageItemParam | LiveInitialAssistantMessageItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.input[].content[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "input_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text",
   "text",
   "output_text"
  ],
  "nullable": false,
  "description": "The text content type. Always `input_text`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.input[].content[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The message text to include in the Live session’s initial conversation history.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Startup audio configuration. Only primary WebSockets accept audio.format; WebRTC and SIP negotiate their media format. Voice and format are immutable after startup.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.audio.format",
  "location": "body",
  "type": "LiveSessionAudioFormatPCMParam | LiveSessionAudioFormatPCMUParam | LiveSessionAudioFormatPCMAParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Audio encoding and sample rate for audio sent and received over a Live WebSocket connection. WebRTC and SIP negotiate their media format separately.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.audio.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "audio/pcm",
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio encoding. Always `audio/pcm`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveSessionAudioFormatPCMParam | LiveSessionAudioFormatPCMUParam | LiveSessionAudioFormatPCMAParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.audio.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 16000,
  "maximum": 24000,
  "enum": [
   16000,
   24000
  ],
  "nullable": false,
  "description": "Audio sample rate in hertz. Live WebSocket PCM audio supports 16000 or 24000 Hz.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveSessionAudioFormatPCMParam | LiveSessionAudioFormatPCMUParam | LiveSessionAudioFormatPCMAParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Settings for speech generated by the Live model. Choose the voice before starting the session.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.audio.output.voice",
  "location": "body",
  "type": "object | LiveCustomVoiceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.audio.output.voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveCustomVoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "client",
  "minimum": null,
  "maximum": null,
  "enum": [
   "client",
   "responses"
  ],
  "nullable": false,
  "description": "The delegation owner. Always `client` for tasks handled by your application.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveClientDelegationParam | LiveResponsesDelegationParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Model, prompt, and tool settings for tasks delegated by the Live session to a Responses backend.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveResponsesDelegationParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The model used for server-owned Responses delegations.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.max_output_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.service_tier",
  "location": "body",
  "type": "LiveResponsesServiceTier | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "fast_tier_temp_pilot",
   "flex",
   "priority",
   "ultrafast"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.reasoning",
  "location": "body",
  "type": "LiveDelegationReasoningInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.reasoning.effort",
  "location": "body",
  "type": "LiveReasoningEffort | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.reasoning.summary",
  "location": "body",
  "type": "LiveReasoningSummary | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "concise",
   "detailed",
   "auto"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.text",
  "location": "body",
  "type": "LiveDelegationTextInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.text.verbosity",
  "location": "body",
  "type": "LiveTextVerbosity | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationTextInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tools",
  "location": "body",
  "type": "array<LiveFunctionToolInputParam | LiveWebSearchToolInputParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the Responses backend while it handles tasks delegated by the Live model.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "web_search"
  ],
  "nullable": false,
  "description": "The tool type. Always `function`.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam | LiveWebSearchToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name the delegated Responses model uses when calling this function.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tools[].parameters",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tools[].strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tool_choice",
  "location": "body",
  "type": "LiveToolChoiceEnum | LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "none",
   "required"
  ],
  "nullable": false,
  "description": "Controls which tool the Responses backend uses when handling a task delegated by the Live model.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.delegation.responses.parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.store",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether to store the session for later forking and recording download. Defaults to false for new sessions.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.client",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Startup-only capabilities for an untrusted frontend attached to a unified WebRTC session. Trusted sideband connections are unaffected.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.client.data_channel",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Control which Live events an untrusted WebRTC frontend can send and receive over its data channel. These restrictions do not apply to trusted sideband connections.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.client.data_channel.allowed_client_events",
  "location": "body",
  "type": "enum | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "all"
  ],
  "nullable": false,
  "description": "Client event types that the frontend data channel may send. Use 'all' to allow every client event; an empty array allows none. Omission preserves the existing allow-all behavior.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.start",
  "parameter": "session.client.data_channel.allowed_server_events",
  "location": "body",
  "type": "enum | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "all"
  ],
  "nullable": false,
  "description": "Server events that may be sent to the frontend data channel. Use 'all' to allow every server event; an empty array allows none. Omission preserves the existing allow-all behavior. Responses events use an object with type 'response.event' and a response_event selector.",
  "compatible_models": [
   "gpt-live-1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.start",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.start"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.start`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Overrides for a stored session after connecting to the fork WebSocket. An empty object inherits the stored configuration; do not supply a new model. audio.format applies only to the new WebSocket connection. client overrides are only supported for WebRTC forks.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Audio format for the new WebSocket connection to a forked Live session. The stored voice is preserved.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.audio.format",
  "location": "body",
  "type": "LiveSessionAudioFormatPCMParam | LiveSessionAudioFormatPCMUParam | LiveSessionAudioFormatPCMAParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Audio encoding and sample rate for audio sent and received over a Live WebSocket connection. WebRTC and SIP negotiate their media format separately.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.audio.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "audio/pcm",
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio encoding. Always `audio/pcm`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveSessionAudioFormatPCMParam | LiveSessionAudioFormatPCMUParam | LiveSessionAudioFormatPCMAParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.audio.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 16000,
  "maximum": 24000,
  "enum": [
   16000,
   24000
  ],
  "nullable": false,
  "description": "Audio sample rate in hertz. Live WebSocket PCM audio supports 16000 or 24000 Hz.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveSessionAudioFormatPCMParam | LiveSessionAudioFormatPCMUParam | LiveSessionAudioFormatPCMAParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Update the Responses backend for an existing Live session without changing delegation ownership.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "responses",
  "minimum": null,
  "maximum": null,
  "enum": [
   "responses"
  ],
  "nullable": false,
  "description": "The delegation owner. Always `responses` for tasks handled by the Responses API.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Updates to the Responses backend of an existing Live session. Omitted settings retain their current values.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Responses backend model to use for subsequent delegated requests. Omit to keep the current backend model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.max_output_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.service_tier",
  "location": "body",
  "type": "LiveResponsesServiceTier | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "fast_tier_temp_pilot",
   "flex",
   "priority",
   "ultrafast"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.reasoning",
  "location": "body",
  "type": "LiveDelegationReasoningInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.reasoning.effort",
  "location": "body",
  "type": "LiveReasoningEffort | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.reasoning.summary",
  "location": "body",
  "type": "LiveReasoningSummary | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "concise",
   "detailed",
   "auto"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.text",
  "location": "body",
  "type": "LiveDelegationTextInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.text.verbosity",
  "location": "body",
  "type": "LiveTextVerbosity | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationTextInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tools",
  "location": "body",
  "type": "array<LiveFunctionToolInputParam | LiveWebSearchToolInputParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the Responses backend while it handles tasks delegated by the Live model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "web_search"
  ],
  "nullable": false,
  "description": "The tool type. Always `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam | LiveWebSearchToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name the delegated Responses model uses when calling this function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tools[].parameters",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tools[].strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tool_choice",
  "location": "body",
  "type": "LiveToolChoiceEnum | LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "none",
   "required"
  ],
  "nullable": false,
  "description": "Controls which tool the Responses backend uses when handling a task delegated by the Live model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.delegation.responses.parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.store",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether to store the forked session. Omission inherits the stored session's setting.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.client",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Startup-only capabilities for an untrusted frontend attached to a unified WebRTC session. Trusted sideband connections are unaffected.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.client.data_channel",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Control which Live events an untrusted WebRTC frontend can send and receive over its data channel. These restrictions do not apply to trusted sideband connections.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.client.data_channel.allowed_client_events",
  "location": "body",
  "type": "enum | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "all"
  ],
  "nullable": false,
  "description": "Client event types that the frontend data channel may send. Use 'all' to allow every client event; an empty array allows none. Omission preserves the existing allow-all behavior.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions/{session_id}/fork session.start",
  "parameter": "session.client.data_channel.allowed_server_events",
  "location": "body",
  "type": "enum | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "all"
  ],
  "nullable": false,
  "description": "Server events that may be sent to the frontend data channel. Use 'all' to allow every server event; an empty array allows none. Omission preserves the existing allow-all behavior. Responses events use an object with type 'response.event' and a response_event selector.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/fork-websocket#session.start",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.update",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.update"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.update`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Changes to an active Live session. Only delegation backend settings can be updated after startup.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "client",
  "minimum": null,
  "maximum": null,
  "enum": [
   "client",
   "responses"
  ],
  "nullable": false,
  "description": "The delegation owner. Always `client` for tasks handled by your application.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveClientDelegationParam | LiveResponsesDelegationUpdateParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Updates to the Responses backend of an existing Live session. Omitted settings retain their current values.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveResponsesDelegationUpdateParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Responses backend model to use for subsequent delegated requests. Omit to keep the current backend model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.max_output_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.service_tier",
  "location": "body",
  "type": "LiveResponsesServiceTier | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "fast_tier_temp_pilot",
   "flex",
   "priority",
   "ultrafast"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.reasoning",
  "location": "body",
  "type": "LiveDelegationReasoningInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.reasoning.effort",
  "location": "body",
  "type": "LiveReasoningEffort | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.reasoning.summary",
  "location": "body",
  "type": "LiveReasoningSummary | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "concise",
   "detailed",
   "auto"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationReasoningInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.text",
  "location": "body",
  "type": "LiveDelegationTextInputParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.text.verbosity",
  "location": "body",
  "type": "LiveTextVerbosity | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveDelegationTextInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tools",
  "location": "body",
  "type": "array<LiveFunctionToolInputParam | LiveWebSearchToolInputParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the Responses backend while it handles tasks delegated by the Live model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "web_search"
  ],
  "nullable": false,
  "description": "The tool type. Always `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam | LiveWebSearchToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name the delegated Responses model uses when calling this function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tools[].parameters",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tools[].strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolInputParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tool_choice",
  "location": "body",
  "type": "LiveToolChoiceEnum | LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "none",
   "required"
  ],
  "nullable": false,
  "description": "Controls which tool the Responses backend uses when handling a task delegated by the Live model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveFunctionToolChoiceParam | LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LiveMCPToolChoiceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.update",
  "parameter": "session.delegation.responses.parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.input_audio.append",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.input_audio.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.input_audio.append",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.input_audio.append",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.input_audio.append"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.input_audio.append`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.input_audio.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.input_audio.append",
  "parameter": "audio",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64-encoded raw audio in the startup-selected format, without a WAV or other container header. Primary WebSocket only; media transports use their audio track. Audio appends have no acknowledgment. Reflected sideband server events reuse this event type and audio key, with no timestamps or event_id; their audio is always mono PCM16LE at 24 kHz.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.input_audio.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.input_audio.mute",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.input_audio.mute",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.input_audio.mute",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.input_audio.mute",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.input_audio.mute"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.input_audio.mute`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.input_audio.mute",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.input_audio.unmute",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.input_audio.unmute",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.input_audio.unmute",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.input_audio.unmute",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.input_audio.unmute"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.input_audio.unmute`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.input_audio.unmute",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.instructions.append",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.instructions.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.instructions.append",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.instructions.append",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.instructions.append"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.instructions.append`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.instructions.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.instructions.append",
  "parameter": "delegation_id",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.instructions.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.instructions.append",
  "parameter": "content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Instruction text to append, limited to 500 tokens. This is a plain string, not an array of content parts.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.instructions.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.thinking.append",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.thinking.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.thinking.append",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.thinking.append",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.thinking.append"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.thinking.append`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.thinking.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.thinking.append",
  "parameter": "delegation_id",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.thinking.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.thinking.append",
  "parameter": "content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Silent reasoning or progress context, limited to 500 tokens. It does not directly request speech, but can influence later speech and is not a secrecy boundary.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.thinking.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.commentary.append",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.commentary.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.commentary.append",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.commentary.append",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.commentary.append"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.commentary.append`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.commentary.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.commentary.append",
  "parameter": "delegation_id",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.commentary.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.commentary.append",
  "parameter": "content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Speakable context for the Live model, limited to 500 tokens. Use this for a result the model should communicate; use session.thinking.append for silent context.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.commentary.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "response.item.create",
  "minimum": null,
  "maximum": null,
  "enum": [
   "response.item.create"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `response.item.create`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item",
  "location": "body",
  "type": "EasyInputMessage | Item | CompactionTriggerItemParam | ItemReferenceParam | ProgramItemParam | ProgramOutputItemParam",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An input item to append to the Responses backend conversation, such as a user message or a function tool result.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.role",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant",
   "system",
   "developer"
  ],
  "nullable": false,
  "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input message | Output message | AdditionalToolsItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content",
  "location": "body",
  "type": "string | InputMessageContentList",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Text, image, or audio input to the model, used to generate a response.\nCan also contain previous assistant responses.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input message | Output message | Reasoning",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.phase",
  "location": "body",
  "type": "MessagePhase | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "commentary",
   "final_answer"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input message | Output message",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "message",
   "file_search_call",
   "computer_call",
   "computer_call_output",
   "web_search_call",
   "function_call",
   "function_call_output",
   "tool_search_call",
   "tool_search_output",
   "additional_tools",
   "configuration_update",
   "reasoning",
   "compaction",
   "image_generation_call",
   "code_interpreter_call",
   "local_shell_call",
   "local_shell_call_output",
   "shell_call",
   "shell_call_output",
   "apply_patch_call",
   "apply_patch_call_output",
   "mcp_list_tools",
   "mcp_approval_request",
   "mcp_approval_response",
   "mcp_call",
   "custom_tool_call_output",
   "custom_tool_call",
   "compaction_trigger",
   "item_reference",
   "program",
   "program_output"
  ],
  "nullable": false,
  "description": "The type of the message input. Always `message`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input message | Output message | File search tool call | Computer tool call | Computer tool call output | Web search tool call | Function tool call | Function tool call output | ToolSearchCallItemParam | ToolSearchOutputItemParam | AdditionalToolsItemParam | ResponseConfigurationUpdateItemParam | Reasoning | Compaction item | Image generation call | Code interpreter tool call | Local shell call | Local shell call output | Shell tool call | Shell tool call output | Apply patch tool call | Apply patch tool call output | MCP list tools | MCP approval request | MCP approval response | MCP tool call | Custom tool call output | Compaction trigger | Item reference | ProgramItemParam | ProgramOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete",
   "searching",
   "failed",
   "generating",
   "interpreting",
   "calling"
  ],
  "nullable": false,
  "description": "The status of item. One of `in_progress`, `completed`, or\n`incomplete`. Populated when items are returned via API.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input message | Output message | File search tool call | Computer tool call | Computer tool call output | Web search tool call | Function tool call | Function tool call output | ToolSearchCallItemParam | ToolSearchOutputItemParam | Reasoning | Image generation call | Code interpreter tool call | Local shell call | Local shell call output | Shell tool call | Shell tool call output | Apply patch tool call | Apply patch tool call output | MCP tool call | ProgramOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "input_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text",
   "input_image",
   "input_file",
   "output_text",
   "refusal",
   "reasoning_text"
  ],
  "nullable": false,
  "description": "The type of the input item. Always `input_text`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input text | Input image | Input file | Output text | Refusal",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The text input to the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input text | Output text",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input text | Input image | Input file",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "nullable": false,
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].image_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input image",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input image | Input file",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].detail",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "high",
   "auto",
   "original"
  ],
  "nullable": false,
  "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input image | Input file",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].filename",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the file to be sent to the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input file",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].file_data",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The content of the file to be sent to the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input file",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].file_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL of the file to be sent to the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Input file",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique ID of the output message.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Output message | File search tool call | Computer tool call | Computer tool call output | Web search tool call | Function tool call | Function tool call output | ToolSearchCallItemParam | ToolSearchOutputItemParam | AdditionalToolsItemParam | ResponseConfigurationUpdateItemParam | Reasoning | Compaction item | Image generation call | Code interpreter tool call | Local shell call | Local shell call output | Shell tool call | Shell tool call output | Apply patch tool call | Apply patch tool call output | MCP list tools | MCP approval request | MCP approval response | MCP tool call | Custom tool call output | Compaction trigger | Item reference | ProgramItemParam | ProgramOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations",
  "location": "body",
  "type": "array<Annotation>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The annotations of the text output.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Output text",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "file_citation",
  "minimum": null,
  "maximum": null,
  "enum": [
   "file_citation",
   "url_citation",
   "container_file_citation",
   "file_path"
  ],
  "nullable": false,
  "description": "The type of the file citation. Always `file_citation`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File citation | URL citation | Container file citation | File path",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations[].file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the file.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File citation | Container file citation | File path",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations[].index",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The index of the file in the list of files.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File citation | File path",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations[].filename",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The filename of the file cited.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File citation | Container file citation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations[].url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL of the web resource.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "URL citation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations[].start_index",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The index of the first character of the URL citation in the message.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "URL citation | Container file citation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations[].end_index",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The index of the last character of the URL citation in the message.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "URL citation | Container file citation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations[].title",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The title of the web resource.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "URL citation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].annotations[].container_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the container file.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Container file citation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].logprobs",
  "location": "body",
  "type": "array<LogProb>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Output text",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].logprobs[].token",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].logprobs[].logprob",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].logprobs[].bytes",
  "location": "body",
  "type": "array<integer>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].logprobs[].top_logprobs",
  "location": "body",
  "type": "array<TopLogProb>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].logprobs[].top_logprobs[].token",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].logprobs[].top_logprobs[].logprob",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].logprobs[].top_logprobs[].bytes",
  "location": "body",
  "type": "array<integer>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.content[].refusal",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The refusal explanation from the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Refusal",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.queries",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The queries used to search for files.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File search tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.results",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File search tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.call_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An identifier used when responding to the tool call with output.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Computer tool call | Computer tool call output | Function tool call | Function tool call output | ToolSearchCallItemParam | ToolSearchOutputItemParam | Local shell call | Shell tool call | Shell tool call output | Apply patch tool call | Apply patch tool call output | Custom tool call output | ProgramItemParam | ProgramOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action",
  "location": "body",
  "type": "ClickParam | DoubleClickAction | DragParam | KeyPressAction | MoveParam | ScreenshotParam | ScrollParam | TypeParam | WaitParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An object describing the specific action taken in this web search call.\nIncludes details on how the model used the web (search, open_page, find_in_page).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Computer tool call | Web search tool call | Image generation call | Local shell call | Shell tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "click",
  "minimum": null,
  "maximum": null,
  "enum": [
   "click",
   "double_click",
   "drag",
   "keypress",
   "move",
   "screenshot",
   "scroll",
   "type",
   "wait",
   "search",
   "open_page",
   "find_in_page",
   "exec"
  ],
  "nullable": false,
  "description": "Specifies the event type. For a click action, this property is always `click`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click | DoubleClick | Drag | KeyPress | Move | Screenshot | Scroll | Type | Wait | Search action | Open page action | Find action",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.button",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "left",
   "right",
   "wheel",
   "back",
   "forward"
  ],
  "nullable": false,
  "description": "Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.x",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The x-coordinate where the click occurred.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click | DoubleClick | Move | Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.y",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The y-coordinate where the click occurred.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click | DoubleClick | Move | Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.keys",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click | DoubleClick | Drag | KeyPress | Move | Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.path",
  "location": "body",
  "type": "array<CoordParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n```\n[\n  { x: 100, y: 200 },\n  { x: 200, y: 300 }\n]\n```",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Drag",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.path[].x",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The x-coordinate.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.path[].y",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The y-coordinate.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.scroll_x",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The horizontal scroll distance.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.scroll_y",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The vertical scroll distance.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The text to type.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Type",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions",
  "location": "body",
  "type": "array<ComputerAction>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Flattened batched actions for `computer_use`. Each action includes an\n`type` discriminator and action-specific fields.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Computer tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "click",
  "minimum": null,
  "maximum": null,
  "enum": [
   "click",
   "double_click",
   "drag",
   "keypress",
   "move",
   "screenshot",
   "scroll",
   "type",
   "wait"
  ],
  "nullable": false,
  "description": "Specifies the event type. For a click action, this property is always `click`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click | DoubleClick | Drag | KeyPress | Move | Screenshot | Scroll | Type | Wait",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].button",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "left",
   "right",
   "wheel",
   "back",
   "forward"
  ],
  "nullable": false,
  "description": "Indicates which mouse button was pressed during the click. One of `left`, `right`, `wheel`, `back`, or `forward`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].x",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The x-coordinate where the click occurred.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click | DoubleClick | Move | Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].y",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The y-coordinate where the click occurred.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click | DoubleClick | Move | Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].keys",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Click | DoubleClick | Drag | KeyPress | Move | Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].path",
  "location": "body",
  "type": "array<CoordParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg\n```\n[\n  { x: 100, y: 200 },\n  { x: 200, y: 300 }\n]\n```",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Drag",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].path[].x",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The x-coordinate.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].path[].y",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The y-coordinate.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].scroll_x",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The horizontal scroll distance.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].scroll_y",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The vertical scroll distance.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Scroll",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.actions[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The text to type.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Type",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.pending_safety_checks",
  "location": "body",
  "type": "array<ComputerCallSafetyCheckParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The pending safety checks for the computer call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Computer tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.pending_safety_checks[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the pending safety check.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.pending_safety_checks[].code",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.pending_safety_checks[].message",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A computer screenshot image used with the computer use tool.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Computer tool call output | Function tool call output | Local shell call output | Shell tool call output | Apply patch tool call output | MCP tool call | Custom tool call output",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "computer_screenshot",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_screenshot"
  ],
  "nullable": false,
  "description": "Specifies the event type. For a computer screenshot, this property is \nalways set to `computer_screenshot`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output.image_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL of the screenshot image.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output.file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The identifier of an uploaded file that contains the screenshot.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.acknowledged_safety_checks",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Computer tool call output",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.query",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The search query.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Search action",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.queries",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The search queries.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Search action",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.sources",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The sources used in the search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Search action",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.sources[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "url"
  ],
  "nullable": false,
  "description": "The type of source. Always `url`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.sources[].url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL of the source.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL opened by the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Open page action | Find action",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.pattern",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The pattern or text to search for within the page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Find action",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.caller",
  "location": "body",
  "type": "ToolCallCaller | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool call | Function tool call output | Shell tool call | Shell tool call output | Apply patch tool call | Apply patch tool call output | Custom tool call output",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.caller.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "direct",
  "minimum": null,
  "maximum": null,
  "enum": [
   "direct",
   "program"
  ],
  "nullable": false,
  "description": "The caller type. Always `direct`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "DirectToolCallCaller | ProgramToolCallCaller | DirectToolCallCallerParam | ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.caller.caller_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The call ID of the program item that produced this tool call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ProgramToolCallCaller | ProgramToolCallCallerParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.namespace",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The namespace of the function to run.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool call | Function tool call output | Custom tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function to run.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool call | Function tool call output | MCP approval request | MCP tool call | Custom tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.arguments",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A JSON string of the arguments to pass to the function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool call | ToolSearchCallItemParam | MCP approval request | MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the function tool call runs asynchronously.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool call | Custom tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server",
   "client"
  ],
  "nullable": false,
  "description": "Whether tool search was executed by the server or by the client.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ToolSearchCallItemParam | ToolSearchOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools",
  "location": "body",
  "type": "array<Tool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The loaded tool definitions returned by the tool search output.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ToolSearchOutputItemParam | AdditionalToolsItemParam | MCP list tools",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "file_search",
   "computer",
   "computer_use_preview",
   "web_search",
   "web_search_2025_08_26",
   "mcp",
   "code_interpreter",
   "programmatic_tool_calling",
   "image_generation",
   "local_shell",
   "shell",
   "custom",
   "namespace",
   "tool_search",
   "web_search_preview",
   "web_search_preview_2025_03_11",
   "apply_patch"
  ],
  "nullable": false,
  "description": "The type of the function tool. Always `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function | File search | Computer | Computer use preview | Web search | MCP tool | Code interpreter | ProgrammaticToolCallingParam | Image generation tool | Local shell tool | Shell tool | Custom tool | Namespace | Tool search tool | Web search preview | Apply patch tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function to call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function | Custom tool | Namespace",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the tool response can be returned asynchronously versus immediately returned on next response creation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function | Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional description of the custom tool, used to provide more context.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function | Custom tool | Namespace | Tool search tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].parameters",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function | Tool search tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].output_schema",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether this function is deferred and loaded via tool search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function | MCP tool | Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].allowed_callers",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function | MCP tool | Code interpreter | Shell tool | Custom tool | Apply patch tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].vector_store_ids",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The IDs of the vector stores to search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File search",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].max_num_results",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The maximum number of results to return. This number should be between 1 and 50 inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File search",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].ranking_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Ranking options for search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File search",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].ranking_options.ranker",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default-2024-11-15"
  ],
  "nullable": false,
  "description": "The ranker to use for the file search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].ranking_options.score_threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].ranking_options.hybrid_search",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].ranking_options.hybrid_search.embedding_weight",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The weight of the embedding in the reciprocal ranking fusion.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].ranking_options.hybrid_search.text_weight",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The weight of the text in the reciprocal ranking fusion.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].filters",
  "location": "body",
  "type": "Filters | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "File search | Web search",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].filters.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "eq",
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "gt",
   "gte",
   "lt",
   "lte",
   "in",
   "nin",
   "and",
   "or"
  ],
  "nullable": false,
  "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n- `in`: in\n- `nin`: not in",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Comparison Filter | Compound Filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].filters.key",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The key to compare against the value.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Comparison Filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].filters.value",
  "location": "body",
  "type": "string | number | boolean | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The value to compare against the attribute key; supports string, number, or boolean types.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Comparison Filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].filters.filters",
  "location": "body",
  "type": "array<ComparisonFilter | object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Compound Filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].filters.filters[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "eq",
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "gt",
   "gte",
   "lt",
   "lte",
   "in",
   "nin"
  ],
  "nullable": false,
  "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n- `in`: in\n- `nin`: not in",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Comparison Filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].filters.filters[].key",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The key to compare against the value.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Comparison Filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].filters.filters[].value",
  "location": "body",
  "type": "string | number | boolean | array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The value to compare against the attribute key; supports string, number, or boolean types.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Comparison Filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "windows",
   "mac",
   "linux",
   "ubuntu",
   "browser"
  ],
  "nullable": false,
  "description": "The type of computer environment to control.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Computer use preview | Shell tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].display_width",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The width of the computer display.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Computer use preview",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].display_height",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The height of the computer display.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Computer use preview",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].external_web_access",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Web search",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].filters.allowed_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].user_location",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Web search | Web search preview",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].user_location.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "approximate",
  "minimum": null,
  "maximum": null,
  "enum": [
   "approximate"
  ],
  "nullable": false,
  "description": "The type of location approximation. Always `approximate`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Web search approximate location | ApproximateLocation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].user_location.country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Web search approximate location | ApproximateLocation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].user_location.region",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Web search approximate location | ApproximateLocation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].user_location.city",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Web search approximate location | ApproximateLocation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].user_location.timezone",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Web search approximate location | ApproximateLocation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].search_context_size",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "nullable": false,
  "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Web search | Web search preview",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A label for this MCP server, used to identify it in tool calls.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].server_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].connector_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "connector_dropbox",
   "connector_gmail",
   "connector_googlecalendar",
   "connector_googledrive",
   "connector_microsoftteams",
   "connector_outlookcalendar",
   "connector_outlookemail",
   "connector_sharepoint"
  ],
  "nullable": false,
  "description": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).\n\nThis field is deprecated for models released after September 1, 2026.\nUse `server_url` to connect to a remote MCP server, or `tunnel_id` to\nconnect through a Secure MCP Tunnel.\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tunnel_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].authorization",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].server_description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional description of the MCP server, used to provide more context.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].allowed_tools",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].allowed_tools.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].allowed_tools.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].require_approval",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].require_approval.always",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].require_approval.always.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].require_approval.always.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].require_approval.never",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].require_approval.never.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].require_approval.never.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container",
  "location": "body",
  "type": "string | AutoCodeInterpreterToolParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The code interpreter container. Can be a container ID or an object that\nspecifies uploaded file IDs to make available to your code, along with an\noptional `memory_limit` setting.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Code interpreter",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "nullable": false,
  "description": "Always `auto`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "CodeInterpreterToolAuto",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.file_ids",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional list of uploaded files to make available to your code.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "CodeInterpreterToolAuto",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.memory_limit",
  "location": "body",
  "type": "ContainerMemoryLimit | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1g",
   "4g",
   "16g",
   "64g"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "CodeInterpreterToolAuto",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.network_policy",
  "location": "body",
  "type": "ContainerNetworkPolicyDisabledParam | ContainerNetworkPolicyAllowlistParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Network access policy for the container.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "CodeInterpreterToolAuto",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.network_policy.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "disabled",
  "minimum": null,
  "maximum": null,
  "enum": [
   "disabled",
   "allowlist"
  ],
  "nullable": false,
  "description": "Disable outbound network access. Always `disabled`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerNetworkPolicyDisabledParam | ContainerNetworkPolicyAllowlistParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.network_policy.allowed_domains",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A list of allowed domains when type is `allowlist`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerNetworkPolicyAllowlistParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.network_policy.domain_secrets",
  "location": "body",
  "type": "array<ContainerNetworkPolicyDomainSecretParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional domain-scoped secrets for allowlisted domains.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerNetworkPolicyAllowlistParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.network_policy.domain_secrets[].domain",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The domain associated with the secret.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.network_policy.domain_secrets[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the secret to inject for the domain.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].container.network_policy.domain_secrets[].value",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The secret value to inject for the domain.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-image-1",
   "gpt-image-1-mini",
   "gpt-image-1.5",
   "gpt-image-2",
   "gpt-image-2-2026-04-21",
   "gpt-image-2.5-sunburst",
   "gpt-image-2.5-sunburst-2026-09-08",
   "gpt-image-2.5-flare",
   "gpt-image-2.5-flare-2026-09-08"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].quality",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max",
   "auto"
  ],
  "nullable": false,
  "description": "The quality of the generated image. The GPT image models support `low`,\n`medium`, and `high`. `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`,\nincluding their `2026-09-08` snapshots, also support `xhigh` and `max`.\nDefault: `auto`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].size",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1024x1024",
   "1024x1536",
   "1536x1024",
   "auto"
  ],
  "nullable": false,
  "description": "The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].output_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "png",
  "minimum": null,
  "maximum": null,
  "enum": [
   "png",
   "webp",
   "jpeg"
  ],
  "nullable": false,
  "description": "The output format of the generated image. One of `png`, `webp`, or\n`jpeg`. Default: `png`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].output_compression",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 100,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "nullable": false,
  "description": "Compression level for the output image. Default: 100.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].moderation",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low"
  ],
  "nullable": false,
  "description": "Moderation level for the generated image. Default: `auto`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].background",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "transparent",
   "opaque",
   "auto"
  ],
  "nullable": false,
  "description": "Set the background of the generated image. One of `transparent`, `opaque`,\nor `auto`. `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including\ntheir `2026-09-08` snapshots, support `opaque` and `transparent`\nbackgrounds. Transparent backgrounds are available for supported GPT Image\nmodels. For `gpt-image-2` and `gpt-image-2-2026-04-21`, this support is in\npreview. When using `transparent`, set the output format to `png` or `webp`.\nDefault: `auto`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].input_fidelity",
  "location": "body",
  "type": "InputFidelity | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "high",
   "low"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].input_image_mask",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional mask for inpainting. Contains `image_url`\n(string, optional) and `file_id` (string, optional).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].input_image_mask.image_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64-encoded mask image.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].input_image_mask.file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "File ID for the mask image.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].partial_images",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 0,
  "minimum": 0,
  "maximum": 3,
  "enum": null,
  "nullable": false,
  "description": "Number of partial images to generate in streaming mode, from 0 (default value) to 3.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].action",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "generate",
   "edit",
   "auto"
  ],
  "nullable": false,
  "description": "Whether to generate a new image or edit an existing image. Default: `auto`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "container_auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "container_auto",
   "local",
   "container_reference"
  ],
  "nullable": false,
  "description": "Automatically creates a container for this request",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerAutoParam | LocalEnvironmentParam | ContainerReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.file_ids",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional list of uploaded files to make available to your code.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerAutoParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.memory_limit",
  "location": "body",
  "type": "ContainerMemoryLimit | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1g",
   "4g",
   "16g",
   "64g"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerAutoParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.network_policy",
  "location": "body",
  "type": "ContainerNetworkPolicyDisabledParam | ContainerNetworkPolicyAllowlistParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Network access policy for the container.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerAutoParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.network_policy.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "disabled",
  "minimum": null,
  "maximum": null,
  "enum": [
   "disabled",
   "allowlist"
  ],
  "nullable": false,
  "description": "Disable outbound network access. Always `disabled`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerNetworkPolicyDisabledParam | ContainerNetworkPolicyAllowlistParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.network_policy.allowed_domains",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A list of allowed domains when type is `allowlist`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerNetworkPolicyAllowlistParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.network_policy.domain_secrets",
  "location": "body",
  "type": "array<ContainerNetworkPolicyDomainSecretParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional domain-scoped secrets for allowlisted domains.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerNetworkPolicyAllowlistParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.network_policy.domain_secrets[].domain",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The domain associated with the secret.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.network_policy.domain_secrets[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the secret to inject for the domain.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.network_policy.domain_secrets[].value",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The secret value to inject for the domain.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills",
  "location": "body",
  "type": "array<SkillReferenceParam | InlineSkillParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional list of skills referenced by id or inline data.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerAutoParam | LocalEnvironmentParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "skill_reference",
  "minimum": null,
  "maximum": null,
  "enum": [
   "skill_reference",
   "inline"
  ],
  "nullable": false,
  "description": "References a skill created with the /v1/skills endpoint.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "SkillReferenceParam | InlineSkillParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the referenced skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "SkillReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].version",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional skill version. Use a positive integer or 'latest'. Omit for default.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "SkillReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "InlineSkillParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The description of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "InlineSkillParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].source",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Inline skill payload",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "InlineSkillParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].source.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "base64",
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "nullable": false,
  "description": "The type of the inline skill source. Must be `base64`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].source.media_type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "application/zip",
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/zip"
  ],
  "nullable": false,
  "description": "The media type of the inline skill payload. Must be `application/zip`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].source.data",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64-encoded skill zip bundle.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.skills[].path",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The path to the directory containing the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].environment.container_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the referenced container.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].format",
  "location": "body",
  "type": "CustomTextFormatParam | CustomGrammarFormatParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The input format for the custom tool. Default is unconstrained text.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "grammar"
  ],
  "nullable": false,
  "description": "Unconstrained text format. Always `text`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Text format | Grammar format",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].format.syntax",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "lark",
   "regex"
  ],
  "nullable": false,
  "description": "The syntax of the grammar definition. One of `lark` or `regex`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Grammar format",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].format.definition",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The grammar definition.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Grammar format",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools",
  "location": "body",
  "type": "array<FunctionToolParam | CustomToolParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The function/custom tools available inside this namespace.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Namespace",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the custom tool, used to identify it in tool calls.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "FunctionToolParam | Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional description of the custom tool, used to provide more context.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "FunctionToolParam | Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].parameters",
  "location": "body",
  "type": "EmptyModelParam | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "FunctionToolParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "FunctionToolParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "custom"
  ],
  "nullable": false,
  "description": "The type of the custom tool. Always `custom`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "FunctionToolParam | Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the tool response can be returned asynchronously versus immediately returned on next response creation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "FunctionToolParam | Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].output_schema",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "FunctionToolParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether this function should be deferred and discovered via tool search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "FunctionToolParam | Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].allowed_callers",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "FunctionToolParam | Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].format",
  "location": "body",
  "type": "CustomTextFormatParam | CustomGrammarFormatParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The input format for the custom tool. Default is unconstrained text.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Custom tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "grammar"
  ],
  "nullable": false,
  "description": "Unconstrained text format. Always `text`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Text format | Grammar format",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].format.syntax",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "lark",
   "regex"
  ],
  "nullable": false,
  "description": "The syntax of the grammar definition. One of `lark` or `regex`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Grammar format",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].tools[].format.definition",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The grammar definition.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Grammar format",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server",
   "client"
  ],
  "nullable": false,
  "description": "Whether tool search is executed by the server or by the client.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Tool search tool",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].search_content_types",
  "location": "body",
  "type": "array<SearchContentType>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Web search preview",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.reasoning",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Updates to reasoning configuration. Only effort is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ResponseConfigurationUpdateItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.reasoning.effort",
  "location": "body",
  "type": "enum | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "nullable": false,
  "description": "The reasoning effort to use for subsequent responses until another\nconfiguration update replaces it.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.encrypted_content",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The encrypted content of the compaction summary.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Reasoning | Compaction item",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.summary",
  "location": "body",
  "type": "array<SummaryTextContent>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Reasoning summary content.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Reasoning",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.summary[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "summary_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "summary_text"
  ],
  "nullable": false,
  "description": "The type of the object. Always `summary_text`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.summary[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A summary of the reasoning output from the model so far.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.result",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The result produced by the program item.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation call | ProgramOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.size",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.quality",
  "location": "body",
  "type": "enum | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max",
   "auto"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.background",
  "location": "body",
  "type": "ImageBackground | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "transparent",
   "opaque",
   "auto"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output_format",
  "location": "body",
  "type": "ImageOutputFormat | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "png",
   "webp",
   "jpeg"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.revised_prompt",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Image generation call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.container_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the container used to run the code.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Code interpreter tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.code",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The JavaScript source executed by programmatic tool calling.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Code interpreter tool call | ProgramItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.outputs",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Code interpreter tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.command",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The command to run.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.working_directory",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.env",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Environment variables to set for the command.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.user",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.commands",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Ordered shell commands for the execution environment to run.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.action.max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.environment",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Shell tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.environment.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "local",
  "minimum": null,
  "maximum": null,
  "enum": [
   "local",
   "container_reference"
  ],
  "nullable": false,
  "description": "Use a local computer environment.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LocalEnvironmentParam | ContainerReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.environment.skills",
  "location": "body",
  "type": "array<LocalSkillParam>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional list of skills.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "LocalEnvironmentParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.environment.skills[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.environment.skills[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The description of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.environment.skills[].path",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The path to the directory containing the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.environment.container_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the referenced container.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ContainerReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output[].stdout",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Captured stdout output for the shell call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output[].stderr",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Captured stderr output for the shell call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output[].outcome",
  "location": "body",
  "type": "FunctionShellCallOutputTimeoutOutcomeParam | FunctionShellCallOutputExitOutcomeParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The exit or timeout outcome associated with this shell call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output[].outcome.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "timeout",
  "minimum": null,
  "maximum": null,
  "enum": [
   "timeout",
   "exit"
  ],
  "nullable": false,
  "description": "The outcome type. Always `timeout`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Shell call timeout outcome | Shell call exit outcome",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.output[].outcome.exit_code",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The exit code returned by the shell process.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Shell call exit outcome",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Shell tool call output",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.operation",
  "location": "body",
  "type": "ApplyPatchCreateFileOperationParam | ApplyPatchDeleteFileOperationParam | ApplyPatchUpdateFileOperationParam",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Apply patch tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.operation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "create_file",
  "minimum": null,
  "maximum": null,
  "enum": [
   "create_file",
   "delete_file",
   "update_file"
  ],
  "nullable": false,
  "description": "The operation type. Always `create_file`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Apply patch create file operation | Apply patch delete file operation | Apply patch update file operation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.operation.path",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path of the file to create relative to the workspace root.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Apply patch create file operation | Apply patch delete file operation | Apply patch update file operation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.operation.diff",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Unified diff content to apply when creating the file.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Apply patch create file operation | Apply patch update file operation",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The label of the MCP server.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP list tools | MCP approval request | MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].input_schema",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The JSON schema describing the tool's input.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.tools[].annotations",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.error",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The error from the tool call, if any.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP list tools | MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.approval_request_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the approval request being answered.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP approval response | MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.approve",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the request was approved.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP approval response",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.reason",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP approval response",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.error.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "mcp_protocol_error",
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_protocol_error",
   "mcp_tool_execution_error",
   "http_error"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCPProtocolError | MCPToolExecutionError | HTTPError",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.error.code",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCPProtocolError | HTTPError",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.error.message",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCPProtocolError | HTTPError",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.error.content",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCPToolExecutionError",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.input",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The input for the custom tool call generated by the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Custom tool call",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.item.create",
  "parameter": "item.fingerprint",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Opaque program replay fingerprint that must be round-tripped.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "ProgramItemParam",
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.create",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions response.create",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "response.create",
  "minimum": null,
  "maximum": null,
  "enum": [
   "response.create"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `response.create`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.close",
  "parameter": "event_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.close",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/live/sessions session.close",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "session.close",
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.close"
  ],
  "nullable": false,
  "description": "The Live client event type. Always `session.close`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/live/primary-websocket#session.close",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-live.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/moderations",
  "parameter": "input",
  "location": "body",
  "type": "string | string[] | array<{type:'text', text} | {type:'image_url', image_url:{url}}>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Content to classify: one string, many strings, or a multimodal array. Images: URL or base64 data URL, <= 20 MB; only omni-moderation models accept images.",
  "compatible_models": [
   "omni-moderation-latest",
   "omni-moderation-2024-09-26"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/moderations",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-moderations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/moderations",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "image_url"
  ],
  "description": "text | image_url (multimodal array items).",
  "compatible_models": [
   "omni-moderation-latest",
   "omni-moderation-2024-09-26"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/moderations",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-moderations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/moderations",
  "parameter": "input[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text to classify (type=text).",
  "compatible_models": [
   "omni-moderation-latest",
   "omni-moderation-2024-09-26"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/moderations",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-moderations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/moderations",
  "parameter": "input[].image_url.url",
  "location": "body",
  "type": "string (uri | data URL)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image URL or data:image/...;base64,... (type=image_url).",
  "compatible_models": [
   "omni-moderation-latest",
   "omni-moderation-2024-09-26"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/moderations",
  "notes": "Live: 1x1 PNG data URL accepted.",
  "_fragment": "generated/fragments/parameters/openai-moderations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/moderations",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "omni-moderation-latest",
  "minimum": null,
  "maximum": null,
  "enum": [
   "omni-moderation-latest",
   "omni-moderation-2024-09-26",
   "text-moderation-latest",
   "text-moderation-stable",
   "text-moderation-007"
  ],
  "description": "omni-moderation-latest (default) | omni-moderation-2024-09-26. text-moderation-latest/stable/007 were removed 2025-10-27.",
  "compatible_models": [
   "omni-moderation-latest",
   "omni-moderation-2024-09-26"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/moderations",
  "notes": "Live: text-moderation-latest -> 400 invalid_request_error param=model 'Invalid value for model'.",
  "_fragment": "generated/fragments/parameters/openai-moderations.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "expires_after",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for the client secret expiration. Expiration refers to the time after which\na client secret will no longer be valid for creating sessions. The session itself may\ncontinue after that time once started. A secret can be used to create multiple sessions\nuntil it expires.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "expires_after.anchor",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "created_at",
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at"
  ],
  "nullable": false,
  "description": "The anchor point for the client secret expiration, meaning that `seconds` will be added to the `created_at` time of the client secret to produce an expiration timestamp. Only `created_at` is currently supported.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "expires_after.seconds",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 600,
  "minimum": 10,
  "maximum": 7200,
  "enum": null,
  "nullable": false,
  "description": "The number of seconds from the anchor point to the expiration. Select a value between `10` and `7200` (2 hours). This default to 600 seconds (10 minutes) if not specified.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session",
  "location": "body",
  "type": "RealtimeSessionCreateRequestGA | RealtimeTranscriptionSessionCreateRequestGA",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Session configuration to use for the client secret. Choose either a realtime\nsession or a transcription session.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "realtime",
   "transcription"
  ],
  "nullable": false,
  "description": "The type of session to create. Always `realtime` for the Realtime API.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration | Realtime transcription session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.output_modalities",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": [
   "audio"
  ],
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-realtime",
   "gpt-realtime-1.5",
   "gpt-realtime-2",
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2025-08-28",
   "gpt-4o-realtime-preview",
   "gpt-4o-realtime-preview-2024-10-01",
   "gpt-4o-realtime-preview-2024-12-17",
   "gpt-4o-realtime-preview-2025-06-03",
   "gpt-4o-mini-realtime-preview",
   "gpt-4o-mini-realtime-preview-2024-12-17",
   "gpt-realtime-mini",
   "gpt-realtime-mini-2025-10-06",
   "gpt-realtime-mini-2025-12-15",
   "gpt-audio-1.5",
   "gpt-audio-mini",
   "gpt-audio-mini-2025-10-06",
   "gpt-audio-mini-2025-12-15"
  ],
  "nullable": false,
  "description": "The Realtime model used for this session.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input and output audio.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration | Realtime transcription session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of the input audio.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio format. Always `audio/pcm`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "PCM audio format | PCMU audio format | PCMA audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   24000
  ],
  "nullable": false,
  "description": "The sample rate of the audio. Always `24000`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "PCM audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.transcription",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.transcription.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "whisper-1",
   "gpt-transcribe",
   "gpt-live-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-mini-transcribe-2025-12-15",
   "gpt-4o-transcribe",
   "gpt-4o-transcribe-diarize",
   "gpt-realtime-whisper"
  ],
  "nullable": false,
  "description": "The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.transcription.language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.transcription.languages",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.transcription.keywords",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.transcription.prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the prompt is a free text string, for example \"expect words related to technology\".\nPrompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.transcription.delay",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Controls how long the model waits before emitting transcription text.\nHigher values can improve transcription accuracy at the cost of latency.\nOnly supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.noise_reduction",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.noise_reduction.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "near_field",
   "far_field"
  ],
  "nullable": false,
  "description": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.turn_detection",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.turn_detection.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "server_vad",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Type of turn detection, `server_vad` to turn on simple Server VAD.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.turn_detection.threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.turn_detection.prefix_padding_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.turn_detection.silence_duration_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.turn_detection.create_response",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.turn_detection.interrupt_response",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.turn_detection.idle_timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.input.turn_detection.eagerness",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "auto"
  ],
  "nullable": false,
  "description": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.output.format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of the output audio.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.output.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio format. Always `audio/pcm`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "PCM audio format | PCMU audio format | PCMA audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.output.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   24000
  ],
  "nullable": false,
  "description": "The sample rate of the audio. Always `24000`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "PCM audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.output.voice",
  "location": "body",
  "type": "VoiceIdsShared | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A built-in voice name or a custom voice reference.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.output.voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The custom voice ID, e.g. `voice_1234`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.audio.output.speed",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0.25,
  "maximum": 1.5,
  "enum": null,
  "nullable": false,
  "description": "The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.include",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration | Realtime transcription session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tracing",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "nullable": true,
  "description": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tracing.workflow_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tracing.group_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tracing.metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools",
  "location": "body",
  "type": "array<RealtimeFunctionTool | MCPTool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the model.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "The type of the tool, i.e. `function`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].parameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Parameters of the function in JSON Schema.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A label for this MCP server, used to identify it in tool calls.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].server_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].connector_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "connector_dropbox",
   "connector_gmail",
   "connector_googlecalendar",
   "connector_googledrive",
   "connector_microsoftteams",
   "connector_outlookcalendar",
   "connector_outlookemail",
   "connector_sharepoint"
  ],
  "nullable": false,
  "description": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).\n\nThis field is deprecated for models released after September 1, 2026.\nUse `server_url` to connect to a remote MCP server, or `tunnel_id` to\nconnect through a Secure MCP Tunnel.\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].tunnel_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].authorization",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].server_description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional description of the MCP server, used to provide more context.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].allowed_tools",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].allowed_tools.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].allowed_tools.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].allowed_callers",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].require_approval",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].require_approval.always",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].require_approval.always.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].require_approval.always.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].require_approval.never",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].require_approval.never.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].require_approval.never.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether this MCP tool is deferred and discovered via tool search.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tool_choice",
  "location": "body",
  "type": "ToolChoiceOptions | ToolChoiceFunction | ToolChoiceMCP",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "auto",
   "required"
  ],
  "nullable": false,
  "description": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "For function calling, the type is always `function`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function to call.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The label of the MCP server to use.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.parallel_tool_calls",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.reasoning",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.reasoning.effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "low",
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.max_output_tokens",
  "location": "body",
  "type": "integer | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "inf"
  ],
  "nullable": false,
  "description": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.truncation",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "disabled"
  ],
  "nullable": false,
  "description": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.truncation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "retention_ratio"
  ],
  "nullable": false,
  "description": "Use retention ratio truncation.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.truncation.retention_ratio",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "nullable": false,
  "description": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.truncation.token_limits",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.truncation.token_limits.post_instructions",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.prompt",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.prompt.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique identifier of the prompt template to use.",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.prompt.version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.prompt.variables",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2",
   "gpt-realtime-1.5",
   "gpt-realtime",
   "gpt-realtime-mini",
   "gpt-4o-realtime-preview",
   "gpt-4o-mini-realtime-preview"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event. This is an arbitrary string that a client may assign. It will be passed back if there is an error with the event, but the corresponding `session.updated` event will not include it.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.update"
  ],
  "nullable": false,
  "description": "The event type, must be `session.update`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session",
  "location": "body",
  "type": "RealtimeSessionCreateRequestGA | RealtimeTranscriptionSessionCreateRequestGA",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Update the Realtime session. Choose either a realtime\nsession or a transcription session.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "realtime",
   "transcription"
  ],
  "nullable": false,
  "description": "The type of session to create. Always `realtime` for the Realtime API.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration | Realtime transcription session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.output_modalities",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": [
   "audio"
  ],
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-realtime",
   "gpt-realtime-1.5",
   "gpt-realtime-2",
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2025-08-28",
   "gpt-4o-realtime-preview",
   "gpt-4o-realtime-preview-2024-10-01",
   "gpt-4o-realtime-preview-2024-12-17",
   "gpt-4o-realtime-preview-2025-06-03",
   "gpt-4o-mini-realtime-preview",
   "gpt-4o-mini-realtime-preview-2024-12-17",
   "gpt-realtime-mini",
   "gpt-realtime-mini-2025-10-06",
   "gpt-realtime-mini-2025-12-15",
   "gpt-audio-1.5",
   "gpt-audio-mini",
   "gpt-audio-mini-2025-10-06",
   "gpt-audio-mini-2025-12-15"
  ],
  "nullable": false,
  "description": "The Realtime model used for this session.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input and output audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration | Realtime transcription session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of the input audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio format. Always `audio/pcm`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format | PCMU audio format | PCMA audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   24000
  ],
  "nullable": false,
  "description": "The sample rate of the audio. Always `24000`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.transcription",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.transcription.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "whisper-1",
   "gpt-transcribe",
   "gpt-live-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-mini-transcribe-2025-12-15",
   "gpt-4o-transcribe",
   "gpt-4o-transcribe-diarize",
   "gpt-realtime-whisper"
  ],
  "nullable": false,
  "description": "The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.transcription.language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.transcription.languages",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.transcription.keywords",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.transcription.prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the prompt is a free text string, for example \"expect words related to technology\".\nPrompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.transcription.delay",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Controls how long the model waits before emitting transcription text.\nHigher values can improve transcription accuracy at the cost of latency.\nOnly supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.noise_reduction",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.noise_reduction.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "near_field",
   "far_field"
  ],
  "nullable": false,
  "description": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.turn_detection",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.turn_detection.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "server_vad",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Type of turn detection, `server_vad` to turn on simple Server VAD.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.turn_detection.threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.turn_detection.prefix_padding_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.turn_detection.silence_duration_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.turn_detection.create_response",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.turn_detection.interrupt_response",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.turn_detection.idle_timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.input.turn_detection.eagerness",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "auto"
  ],
  "nullable": false,
  "description": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.output.format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of the output audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.output.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio format. Always `audio/pcm`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format | PCMU audio format | PCMA audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.output.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   24000
  ],
  "nullable": false,
  "description": "The sample rate of the audio. Always `24000`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.output.voice",
  "location": "body",
  "type": "VoiceIdsShared | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A built-in voice name or a custom voice reference.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.output.voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The custom voice ID, e.g. `voice_1234`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.audio.output.speed",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0.25,
  "maximum": 1.5,
  "enum": null,
  "nullable": false,
  "description": "The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.include",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration | Realtime transcription session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tracing",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "nullable": true,
  "description": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tracing.workflow_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tracing.group_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tracing.metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools",
  "location": "body",
  "type": "array<RealtimeFunctionTool | MCPTool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "The type of the tool, i.e. `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].parameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Parameters of the function in JSON Schema.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A label for this MCP server, used to identify it in tool calls.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].server_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].connector_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "connector_dropbox",
   "connector_gmail",
   "connector_googlecalendar",
   "connector_googledrive",
   "connector_microsoftteams",
   "connector_outlookcalendar",
   "connector_outlookemail",
   "connector_sharepoint"
  ],
  "nullable": false,
  "description": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).\n\nThis field is deprecated for models released after September 1, 2026.\nUse `server_url` to connect to a remote MCP server, or `tunnel_id` to\nconnect through a Secure MCP Tunnel.\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].tunnel_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].authorization",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].server_description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional description of the MCP server, used to provide more context.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].allowed_tools",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].allowed_tools.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].allowed_tools.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].allowed_callers",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].require_approval",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].require_approval.always",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].require_approval.always.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].require_approval.always.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].require_approval.never",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].require_approval.never.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].require_approval.never.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether this MCP tool is deferred and discovered via tool search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tool_choice",
  "location": "body",
  "type": "ToolChoiceOptions | ToolChoiceFunction | ToolChoiceMCP",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "auto",
   "required"
  ],
  "nullable": false,
  "description": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "For function calling, the type is always `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function to call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The label of the MCP server to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.parallel_tool_calls",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.reasoning",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.reasoning.effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "low",
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.max_output_tokens",
  "location": "body",
  "type": "integer | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "inf"
  ],
  "nullable": false,
  "description": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.truncation",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "disabled"
  ],
  "nullable": false,
  "description": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.truncation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "retention_ratio"
  ],
  "nullable": false,
  "description": "Use retention ratio truncation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.truncation.retention_ratio",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "nullable": false,
  "description": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.truncation.token_limits",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.truncation.token_limits.post_instructions",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.prompt",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime session configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.prompt.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique identifier of the prompt template to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.prompt.version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime session.update",
  "parameter": "session.prompt.variables",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "response.create"
  ],
  "nullable": false,
  "description": "The event type, must be `response.create`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Create a new Realtime response with these parameters",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.output_modalities",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The set of modalities the model used to respond, currently the only possible values are\n`[\\\"audio\\\"]`, `[\\\"text\\\"]`. Audio output always include a text transcript. Setting the\noutput to mode `text` will disable audio output from the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for audio input and output.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.audio.output.format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of the output audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.audio.output.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio format. Always `audio/pcm`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format | PCMU audio format | PCMA audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.audio.output.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   24000
  ],
  "nullable": false,
  "description": "The sample rate of the audio. Always `24000`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.audio.output.voice",
  "location": "body",
  "type": "VoiceIdsShared | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A built-in voice name or a custom voice reference.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.audio.output.voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The custom voice ID, e.g. `voice_1234`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools",
  "location": "body",
  "type": "array<RealtimeFunctionTool | MCPTool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "The type of the tool, i.e. `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].parameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Parameters of the function in JSON Schema.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A label for this MCP server, used to identify it in tool calls.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].server_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].connector_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "connector_dropbox",
   "connector_gmail",
   "connector_googlecalendar",
   "connector_googledrive",
   "connector_microsoftteams",
   "connector_outlookcalendar",
   "connector_outlookemail",
   "connector_sharepoint"
  ],
  "nullable": false,
  "description": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).\n\nThis field is deprecated for models released after September 1, 2026.\nUse `server_url` to connect to a remote MCP server, or `tunnel_id` to\nconnect through a Secure MCP Tunnel.\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].tunnel_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].authorization",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].server_description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional description of the MCP server, used to provide more context.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].allowed_tools",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].allowed_tools.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].allowed_tools.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].allowed_callers",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].require_approval",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].require_approval.always",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].require_approval.always.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].require_approval.always.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].require_approval.never",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].require_approval.never.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].require_approval.never.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether this MCP tool is deferred and discovered via tool search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tool_choice",
  "location": "body",
  "type": "ToolChoiceOptions | ToolChoiceFunction | ToolChoiceMCP",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "auto",
   "required"
  ],
  "nullable": false,
  "description": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "For function calling, the type is always `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function to call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The label of the MCP server to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.parallel_tool_calls",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.reasoning",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.reasoning.effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "low",
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.max_output_tokens",
  "location": "body",
  "type": "integer | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "inf"
  ],
  "nullable": false,
  "description": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.conversation",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "none"
  ],
  "nullable": false,
  "description": "Controls which conversation the response is added to. Currently supports\n`auto` and `none`, with `auto` as the default value. The `auto` value\nmeans that the contents of the response will be added to the default\nconversation. Set this to `none` to create an out-of-band response which\nwill not add items to default conversation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.prompt",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.prompt.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique identifier of the prompt template to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.prompt.version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.prompt.variables",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input",
  "location": "body",
  "type": "array<RealtimeConversationItem>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Input items to include in the prompt for the model. Using this field\ncreates a new context for this Response instead of using the default\nconversation. An empty array `[]` will clear the context for this Response.\nNote that this can include references to items that previously appeared in the session\nusing their id.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique ID of the item. This may be provided by the client or generated by the server.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item | Realtime function call item | Realtime function call output item | Realtime MCP approval response | Realtime MCP list tools | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].object",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "realtime.item"
  ],
  "nullable": false,
  "description": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item | Realtime function call item | Realtime function call output item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "message",
   "function_call",
   "function_call_output",
   "mcp_approval_response",
   "mcp_list_tools",
   "mcp_call",
   "mcp_approval_request"
  ],
  "nullable": false,
  "description": "The type of the item. Always `message`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item | Realtime function call item | Realtime function call output item | Realtime MCP approval response | Realtime MCP list tools | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "completed",
   "incomplete",
   "in_progress"
  ],
  "nullable": false,
  "description": "The status of the item. Has no effect on the conversation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item | Realtime function call item | Realtime function call output item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].role",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "system",
   "user",
   "assistant"
  ],
  "nullable": false,
  "description": "The role of the message sender. Always `system`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].content",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The content of the message.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].content[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text",
   "input_audio",
   "input_image",
   "output_text",
   "output_audio"
  ],
  "nullable": false,
  "description": "The content type. Always `input_text` for system messages.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].content[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The text content.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].content[].audio",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].content[].image_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].content[].detail",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "high"
  ],
  "nullable": false,
  "description": "The detail level of the image (for `input_image`). `auto` will default to `high`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].content[].transcript",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].call_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the function call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime function call item | Realtime function call output item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function being called.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime function call item | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].arguments",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime function call item | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].output",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The output of the function call, this is free text and can contain any information or simply be empty.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime function call output item | Realtime MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].approval_request_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the approval request being answered.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP approval response | Realtime MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].approve",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the request was approved.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP approval response",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].reason",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP approval response",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The label of the MCP server.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP list tools | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].tools",
  "location": "body",
  "type": "array<MCPListToolsTool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The tools available on the server.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP list tools",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the tool.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].tools[].input_schema",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The JSON schema describing the tool's input.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].tools[].annotations",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].error",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].error.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "protocol_error",
   "tool_execution_error",
   "http_error"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP protocol error | Realtime MCP tool execution error | Realtime MCP HTTP error",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].error.code",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP protocol error | Realtime MCP HTTP error",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.create",
  "parameter": "response.input[].error.message",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP protocol error | Realtime MCP tool execution error | Realtime MCP HTTP error",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "conversation.item.create"
  ],
  "nullable": false,
  "description": "The event type, must be `conversation.item.create`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "previous_item_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the preceding item after which the new item will be inserted. If not set, the new item will be appended to the end of the conversation.\n\nIf set to `root`, the new item will be added to the beginning of the conversation.\n\nIf set to an existing ID, it allows an item to be inserted mid-conversation. If the ID cannot be found, an error will be returned and the item will not be added.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item",
  "location": "body",
  "type": "RealtimeConversationItemMessageSystem | RealtimeConversationItemMessageUser | RealtimeConversationItemMessageAssistant | RealtimeConversationItemFunctionCall | RealtimeConversationItemFunctionCallOutput | RealtimeMCPApprovalResponse | RealtimeMCPListTools | RealtimeMCPToolCall | RealtimeMCPApprovalRequest",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A single item within a Realtime conversation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique ID of the item. This may be provided by the client or generated by the server.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item | Realtime function call item | Realtime function call output item | Realtime MCP approval response | Realtime MCP list tools | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.object",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "realtime.item"
  ],
  "nullable": false,
  "description": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item | Realtime function call item | Realtime function call output item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "message",
   "function_call",
   "function_call_output",
   "mcp_approval_response",
   "mcp_list_tools",
   "mcp_call",
   "mcp_approval_request"
  ],
  "nullable": false,
  "description": "The type of the item. Always `message`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item | Realtime function call item | Realtime function call output item | Realtime MCP approval response | Realtime MCP list tools | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "completed",
   "incomplete",
   "in_progress"
  ],
  "nullable": false,
  "description": "The status of the item. Has no effect on the conversation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item | Realtime function call item | Realtime function call output item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.role",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "system",
   "user",
   "assistant"
  ],
  "nullable": false,
  "description": "The role of the message sender. Always `system`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.content",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The content of the message.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime system message item | Realtime user message item | Realtime assistant message item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.content[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text",
   "input_audio",
   "input_image",
   "output_text",
   "output_audio"
  ],
  "nullable": false,
  "description": "The content type. Always `input_text` for system messages.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.content[].text",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The text content.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.content[].audio",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.content[].image_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.content[].detail",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "high"
  ],
  "nullable": false,
  "description": "The detail level of the image (for `input_image`). `auto` will default to `high`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.content[].transcript",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.call_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the function call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime function call item | Realtime function call output item",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function being called.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime function call item | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.arguments",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime function call item | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.output",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The output of the function call, this is free text and can contain any information or simply be empty.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime function call output item | Realtime MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.approval_request_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the approval request being answered.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP approval response | Realtime MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.approve",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the request was approved.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP approval response",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.reason",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP approval response",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The label of the MCP server.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP list tools | Realtime MCP tool call | Realtime MCP approval request",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.tools",
  "location": "body",
  "type": "array<MCPListToolsTool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The tools available on the server.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP list tools",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the tool.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.tools[].input_schema",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The JSON schema describing the tool's input.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.tools[].annotations",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.error",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP tool call",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.error.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "protocol_error",
   "tool_execution_error",
   "http_error"
  ],
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP protocol error | Realtime MCP tool execution error | Realtime MCP HTTP error",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.error.code",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP protocol error | Realtime MCP HTTP error",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.create",
  "parameter": "item.error.message",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Realtime MCP protocol error | Realtime MCP tool execution error | Realtime MCP HTTP error",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime input_audio_buffer.append",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#input_audio_buffer.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime input_audio_buffer.append",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_audio_buffer.append"
  ],
  "nullable": false,
  "description": "The event type, must be `input_audio_buffer.append`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#input_audio_buffer.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime input_audio_buffer.append",
  "parameter": "audio",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64-encoded audio bytes. This must be in the format specified by the \n`input_audio_format` field in the session configuration.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#input_audio_buffer.append",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime input_audio_buffer.commit",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#input_audio_buffer.commit",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime input_audio_buffer.commit",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_audio_buffer.commit"
  ],
  "nullable": false,
  "description": "The event type, must be `input_audio_buffer.commit`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#input_audio_buffer.commit",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime input_audio_buffer.clear",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#input_audio_buffer.clear",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime input_audio_buffer.clear",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_audio_buffer.clear"
  ],
  "nullable": false,
  "description": "The event type, must be `input_audio_buffer.clear`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#input_audio_buffer.clear",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.retrieve",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.retrieve",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.retrieve",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "conversation.item.retrieve"
  ],
  "nullable": false,
  "description": "The event type, must be `conversation.item.retrieve`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.retrieve",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.retrieve",
  "parameter": "item_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the item to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.retrieve",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.truncate",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.truncate",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.truncate",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "conversation.item.truncate"
  ],
  "nullable": false,
  "description": "The event type, must be `conversation.item.truncate`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.truncate",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.truncate",
  "parameter": "item_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the assistant message item to truncate. Only assistant message \nitems can be truncated.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.truncate",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.truncate",
  "parameter": "content_index",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The index of the content part to truncate. Set this to `0`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.truncate",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.truncate",
  "parameter": "audio_end_ms",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Inclusive duration up to which audio is truncated, in milliseconds. If \nthe audio_end_ms is greater than the actual audio duration, the server \nwill respond with an error.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.truncate",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.delete",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.delete",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.delete",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "conversation.item.delete"
  ],
  "nullable": false,
  "description": "The event type, must be `conversation.item.delete`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.delete",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime conversation.item.delete",
  "parameter": "item_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The ID of the item to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#conversation.item.delete",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.cancel",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.cancel",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.cancel",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "response.cancel"
  ],
  "nullable": false,
  "description": "The event type, must be `response.cancel`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.cancel",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime response.cancel",
  "parameter": "response_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A specific response ID to cancel - if not provided, will cancel an \nin-progress response in the default conversation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#response.cancel",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime output_audio_buffer.clear",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique ID of the client event used for error handling.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#output_audio_buffer.clear",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime output_audio_buffer.clear",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "output_audio_buffer.clear"
  ],
  "nullable": false,
  "description": "The event type, must be `output_audio_buffer.clear`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/client-events#output_audio_buffer.clear",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "sdp",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "WebRTC Session Description Protocol (SDP) offer generated by the caller.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional session configuration to apply before the realtime session is\ncreated. Use the same parameters you would send in a [`create client secret`](https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets/methods/create)\nrequest.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "realtime"
  ],
  "nullable": false,
  "description": "The type of session to create. Always `realtime` for the Realtime API.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.output_modalities",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": [
   "audio"
  ],
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-realtime",
   "gpt-realtime-1.5",
   "gpt-realtime-2",
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2025-08-28",
   "gpt-4o-realtime-preview",
   "gpt-4o-realtime-preview-2024-10-01",
   "gpt-4o-realtime-preview-2024-12-17",
   "gpt-4o-realtime-preview-2025-06-03",
   "gpt-4o-mini-realtime-preview",
   "gpt-4o-mini-realtime-preview-2024-12-17",
   "gpt-realtime-mini",
   "gpt-realtime-mini-2025-10-06",
   "gpt-realtime-mini-2025-12-15",
   "gpt-audio-1.5",
   "gpt-audio-mini",
   "gpt-audio-mini-2025-10-06",
   "gpt-audio-mini-2025-12-15"
  ],
  "nullable": false,
  "description": "The Realtime model used for this session.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input and output audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of the input audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio format. Always `audio/pcm`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format | PCMU audio format | PCMA audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   24000
  ],
  "nullable": false,
  "description": "The sample rate of the audio. Always `24000`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.transcription",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.transcription.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "whisper-1",
   "gpt-transcribe",
   "gpt-live-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-mini-transcribe-2025-12-15",
   "gpt-4o-transcribe",
   "gpt-4o-transcribe-diarize",
   "gpt-realtime-whisper"
  ],
  "nullable": false,
  "description": "The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.transcription.language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.transcription.languages",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.transcription.keywords",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.transcription.prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the prompt is a free text string, for example \"expect words related to technology\".\nPrompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.transcription.delay",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Controls how long the model waits before emitting transcription text.\nHigher values can improve transcription accuracy at the cost of latency.\nOnly supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.noise_reduction",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.noise_reduction.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "near_field",
   "far_field"
  ],
  "nullable": false,
  "description": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.turn_detection",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.turn_detection.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "server_vad",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Type of turn detection, `server_vad` to turn on simple Server VAD.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.turn_detection.threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.turn_detection.prefix_padding_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.turn_detection.silence_duration_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.turn_detection.create_response",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.turn_detection.interrupt_response",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.turn_detection.idle_timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.input.turn_detection.eagerness",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "auto"
  ],
  "nullable": false,
  "description": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.output.format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of the output audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.output.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio format. Always `audio/pcm`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format | PCMU audio format | PCMA audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.output.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   24000
  ],
  "nullable": false,
  "description": "The sample rate of the audio. Always `24000`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "PCM audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.output.voice",
  "location": "body",
  "type": "VoiceIdsShared | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A built-in voice name or a custom voice reference.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.output.voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The custom voice ID, e.g. `voice_1234`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.audio.output.speed",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0.25,
  "maximum": 1.5,
  "enum": null,
  "nullable": false,
  "description": "The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.include",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tracing",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "nullable": true,
  "description": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tracing.workflow_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tracing.group_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tracing.metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools",
  "location": "body",
  "type": "array<RealtimeFunctionTool | MCPTool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "The type of the tool, i.e. `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].parameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Parameters of the function in JSON Schema.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A label for this MCP server, used to identify it in tool calls.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].server_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].connector_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "connector_dropbox",
   "connector_gmail",
   "connector_googlecalendar",
   "connector_googledrive",
   "connector_microsoftteams",
   "connector_outlookcalendar",
   "connector_outlookemail",
   "connector_sharepoint"
  ],
  "nullable": false,
  "description": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).\n\nThis field is deprecated for models released after September 1, 2026.\nUse `server_url` to connect to a remote MCP server, or `tunnel_id` to\nconnect through a Secure MCP Tunnel.\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].tunnel_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].authorization",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].server_description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional description of the MCP server, used to provide more context.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].allowed_tools",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].allowed_tools.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].allowed_tools.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].allowed_callers",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].require_approval",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].require_approval.always",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].require_approval.always.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].require_approval.always.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].require_approval.never",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].require_approval.never.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].require_approval.never.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether this MCP tool is deferred and discovered via tool search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tool_choice",
  "location": "body",
  "type": "ToolChoiceOptions | ToolChoiceFunction | ToolChoiceMCP",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "auto",
   "required"
  ],
  "nullable": false,
  "description": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "For function calling, the type is always `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function to call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The label of the MCP server to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.parallel_tool_calls",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.reasoning",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.reasoning.effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "low",
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.max_output_tokens",
  "location": "body",
  "type": "integer | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "inf"
  ],
  "nullable": false,
  "description": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.truncation",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "disabled"
  ],
  "nullable": false,
  "description": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.truncation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "retention_ratio"
  ],
  "nullable": false,
  "description": "Use retention ratio truncation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.truncation.retention_ratio",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "nullable": false,
  "description": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.truncation.token_limits",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.truncation.token_limits.post_instructions",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.prompt",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.prompt.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique identifier of the prompt template to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.prompt.version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session.prompt.variables",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls",
  "parameter": "session (JSON string)",
  "location": "body",
  "type": "RealtimeSessionCreateRequestGA | RealtimeTranscriptionSessionCreateRequestGA",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "multipart/form-data part `session` (type=application/json) carrying the same session object as POST /v1/realtime/client_secrets `session` (see those records). When the request body is raw `application/sdp`, no session config can be attached (use an ephemeral client secret minted with the config instead).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "realtime"
  ],
  "nullable": false,
  "description": "The type of session to create. Always `realtime` for the Realtime API.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "output_modalities",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": [
   "audio"
  ],
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "gpt-realtime",
   "gpt-realtime-1.5",
   "gpt-realtime-2",
   "gpt-realtime-2.1",
   "gpt-realtime-2.1-mini",
   "gpt-realtime-2025-08-28",
   "gpt-4o-realtime-preview",
   "gpt-4o-realtime-preview-2024-10-01",
   "gpt-4o-realtime-preview-2024-12-17",
   "gpt-4o-realtime-preview-2025-06-03",
   "gpt-4o-mini-realtime-preview",
   "gpt-4o-mini-realtime-preview-2024-12-17",
   "gpt-realtime-mini",
   "gpt-realtime-mini-2025-10-06",
   "gpt-realtime-mini-2025-12-15",
   "gpt-audio-1.5",
   "gpt-audio-mini",
   "gpt-audio-mini-2025-10-06",
   "gpt-audio-mini-2025-12-15"
  ],
  "nullable": false,
  "description": "The Realtime model used for this session.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input and output audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of the input audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio format. Always `audio/pcm`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "PCM audio format | PCMU audio format | PCMA audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   24000
  ],
  "nullable": false,
  "description": "The sample rate of the audio. Always `24000`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "PCM audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.transcription",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.transcription.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "whisper-1",
   "gpt-transcribe",
   "gpt-live-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-mini-transcribe-2025-12-15",
   "gpt-4o-transcribe",
   "gpt-4o-transcribe-diarize",
   "gpt-realtime-whisper"
  ],
  "nullable": false,
  "description": "The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.transcription.language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.transcription.languages",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.transcription.keywords",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.transcription.prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the prompt is a free text string, for example \"expect words related to technology\".\nPrompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.transcription.delay",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Controls how long the model waits before emitting transcription text.\nHigher values can improve transcription accuracy at the cost of latency.\nOnly supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.noise_reduction",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.noise_reduction.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "near_field",
   "far_field"
  ],
  "nullable": false,
  "description": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.turn_detection",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.turn_detection.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "server_vad",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Type of turn detection, `server_vad` to turn on simple Server VAD.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.turn_detection.threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.turn_detection.prefix_padding_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.turn_detection.silence_duration_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.turn_detection.create_response",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.turn_detection.interrupt_response",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD | Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.turn_detection.idle_timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Server VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.input.turn_detection.eagerness",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "auto"
  ],
  "nullable": false,
  "description": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Semantic VAD",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.output.format",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of the output audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.output.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma"
  ],
  "nullable": false,
  "description": "The audio format. Always `audio/pcm`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "PCM audio format | PCMU audio format | PCMA audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.output.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   24000
  ],
  "nullable": false,
  "description": "The sample rate of the audio. Always `24000`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "PCM audio format",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.output.voice",
  "location": "body",
  "type": "VoiceIdsShared | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A built-in voice name or a custom voice reference.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.output.voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The custom voice ID, e.g. `voice_1234`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "audio.output.speed",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0.25,
  "maximum": 1.5,
  "enum": null,
  "nullable": false,
  "description": "The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "include",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tracing",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "nullable": true,
  "description": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tracing.workflow_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tracing.group_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tracing.metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools",
  "location": "body",
  "type": "array<RealtimeFunctionTool | MCPTool>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools available to the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "The type of the tool, i.e. `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].parameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Parameters of the function in JSON Schema.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A label for this MCP server, used to identify it in tool calls.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].server_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].connector_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "connector_dropbox",
   "connector_gmail",
   "connector_googlecalendar",
   "connector_googledrive",
   "connector_microsoftteams",
   "connector_outlookcalendar",
   "connector_outlookemail",
   "connector_sharepoint"
  ],
  "nullable": false,
  "description": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).\n\nThis field is deprecated for models released after September 1, 2026.\nUse `server_url` to connect to a remote MCP server, or `tunnel_id` to\nconnect through a Secure MCP Tunnel.\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].tunnel_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].authorization",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].server_description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional description of the MCP server, used to provide more context.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].allowed_tools",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].allowed_tools.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].allowed_tools.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].allowed_callers",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].require_approval",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].require_approval.always",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].require_approval.always.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].require_approval.always.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].require_approval.never",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool approval filter",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].require_approval.never.tool_names",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "List of allowed tool names.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].require_approval.never.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether this MCP tool is deferred and discovered via tool search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tool_choice",
  "location": "body",
  "type": "ToolChoiceOptions | ToolChoiceFunction | ToolChoiceMCP",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "auto",
   "required"
  ],
  "nullable": false,
  "description": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tool_choice.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function",
   "mcp"
  ],
  "nullable": false,
  "description": "For function calling, the type is always `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tool_choice.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function to call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Function tool | MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The label of the MCP server to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "MCP tool",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "parallel_tool_calls",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "reasoning",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "reasoning.effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "low",
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "max_output_tokens",
  "location": "body",
  "type": "integer | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "inf"
  ],
  "nullable": false,
  "description": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "truncation",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "disabled"
  ],
  "nullable": false,
  "description": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "truncation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "retention_ratio"
  ],
  "nullable": false,
  "description": "Use retention ratio truncation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "truncation.retention_ratio",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "nullable": false,
  "description": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "truncation.token_limits",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "truncation.token_limits.post_instructions",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "prompt",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "prompt.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique identifier of the prompt template to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "prompt.version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "prompt.variables",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/accept",
  "parameter": "call_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter: call ID from the `realtime.call.incoming` webhook.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/refer",
  "parameter": "target_uri",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "URI that should appear in the SIP Refer-To header. Supports values like\n`tel:+14155550123` or `sip:agent@example.com`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/refer",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/refer",
  "parameter": "call_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/refer",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/reject",
  "parameter": "status_code",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "SIP response code to send back to the caller. Defaults to `603` (Decline)\nwhen omitted.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/reject",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/reject",
  "parameter": "call_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/reject",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/hangup",
  "parameter": "call_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Path parameter. No request body.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/hangup",
   "retrieved_at": "2026-09-19T01:31:51Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "expires_after",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for the client secret expiration. Expiration refers to the time after which\na client secret will no longer be valid for creating sessions. The session itself may\ncontinue after that time once started. A secret can be used to create multiple sessions\nuntil it expires.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "expires_after.anchor",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "created_at",
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at"
  ],
  "nullable": false,
  "description": "The anchor point for the client secret expiration, meaning that `seconds` will be added to the `created_at` time of the client secret to produce an expiration timestamp. Only `created_at` is currently supported.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "expires_after.seconds",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 600,
  "minimum": 10,
  "maximum": 7200,
  "enum": null,
  "nullable": false,
  "description": "The number of seconds from the anchor point to the expiration. Select a value between `10` and `7200` (2 hours). This default to 600 seconds (10 minutes) if not specified.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Realtime translation session configuration. Translation sessions stream source\naudio in and translated audio plus transcript deltas out continuously.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The Realtime translation model used for this session.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for translation input and output audio.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session.audio.input",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session.audio.input.transcription",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session.audio.input.transcription.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The transcription model to use for source transcript deltas.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session.audio.input.noise_reduction",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session.audio.input.noise_reduction.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "near_field",
   "far_field"
  ],
  "nullable": false,
  "description": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session.audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/translations/client_secrets",
  "parameter": "session.audio.output.language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Target language for translated output audio and transcript deltas.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/subresources/client_secrets",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.update"
  ],
  "nullable": false,
  "description": "The event type, must be `session.update`.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "session",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Realtime translation session fields that can be updated with `session.update`.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "session.audio",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for translation input and output audio.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "session.audio.input",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "session.audio.input.transcription",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "session.audio.input.transcription.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The transcription model to use for source transcript deltas.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "session.audio.input.noise_reduction",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "session.audio.input.noise_reduction.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "near_field",
   "far_field"
  ],
  "nullable": false,
  "description": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "session.audio.output",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.update",
  "parameter": "session.audio.output.language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Target language for translated output audio and transcript deltas.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.update",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.input_audio_buffer.append",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.input_audio_buffer.append",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.input_audio_buffer.append",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.input_audio_buffer.append"
  ],
  "nullable": false,
  "description": "The event type, must be `session.input_audio_buffer.append`.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.input_audio_buffer.append",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.input_audio_buffer.append",
  "parameter": "audio",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Base64-encoded 24 kHz PCM16 mono audio bytes.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.input_audio_buffer.append",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.close",
  "parameter": "event_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional client-generated ID used to identify this event.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.close",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime/translations session.close",
  "parameter": "type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "session.close"
  ],
  "nullable": false,
  "description": "The event type, must be `session.close`.",
  "compatible_models": [
   "gpt-realtime-translate"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/resources/realtime/translation-client-events#session.close",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "client_secret",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Ephemeral key returned by the API.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "client_secret.value",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Ephemeral key usable in client environments to authenticate connections\nto the Realtime API. Use this in client-side environments rather than\na standard API token, which should only be used server-side.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "client_secret.expires_at",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Timestamp for when the token expires. Currently, all tokens expire\nafter one minute.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "modalities",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The set of modalities the model can respond with. To disable audio,\nset this to [\"text\"].",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "voice",
  "location": "body",
  "type": "VoiceIdsShared | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "A built-in voice name or a custom voice reference.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "voice.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The custom voice ID, e.g. `voice_1234`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "input_audio_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "output_audio_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "input_audio_transcription",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio transcription, defaults to off and can be\nset to `null` to turn off once on. Input audio transcription is not native\nto the model, since the model consumes audio directly. Transcription runs\nasynchronously and should be treated as rough guidance\nrather than the representation understood by the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "input_audio_transcription.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The model to use for transcription.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "speed",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1,
  "minimum": 0.25,
  "maximum": 1.5,
  "enum": null,
  "nullable": false,
  "description": "The speed of the model's spoken response. 1.0 is the default speed. 0.25 is\nthe minimum speed. 1.5 is the maximum speed. This value can only be changed\nin between model turns, not while a response is in progress.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tracing",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "nullable": false,
  "description": "Configuration options for tracing. Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tracing.workflow_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the workflow to attach to this trace. This is used to\nname the trace in the traces dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tracing.group_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The group id to attach to this trace to enable filtering and\ngrouping in the traces dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tracing.metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The arbitrary metadata to attach to this trace to enable\nfiltering in the traces dashboard.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Tracing Configuration",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "turn_detection",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "turn_detection.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Type of turn detection, only `server_vad` is currently supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "turn_detection.threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "turn_detection.prefix_padding_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "turn_detection.silence_duration_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tools",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Tools (functions) available to the model.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "nullable": false,
  "description": "The type of the tool, i.e. `function`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tools[].name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The name of the function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tools[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tools[].parameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Parameters of the function in JSON Schema.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "tool_choice",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "How the model chooses tools. Options are `auto`, `none`, `required`, or\nspecify a function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "max_response_output_tokens",
  "location": "body",
  "type": "integer | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "inf"
  ],
  "nullable": false,
  "description": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "truncation",
  "location": "body",
  "type": "enum | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "disabled"
  ],
  "nullable": false,
  "description": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "truncation.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "retention_ratio"
  ],
  "nullable": false,
  "description": "Use retention ratio truncation.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "truncation.retention_ratio",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "nullable": false,
  "description": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "truncation.token_limits",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "variant": "Retention ratio truncation",
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "truncation.token_limits.post_instructions",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "prompt",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "prompt.id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The unique identifier of the prompt template to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "prompt.version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/sessions",
  "parameter": "prompt.variables",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "turn_detection",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for turn detection. Can be set to `null` to turn off. Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "turn_detection.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server_vad"
  ],
  "nullable": false,
  "description": "Type of turn detection. Only `server_vad` is currently supported for transcription sessions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "turn_detection.threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "turn_detection.prefix_padding_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "turn_detection.silence_duration_ms",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_noise_reduction",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_noise_reduction.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "near_field",
   "far_field"
  ],
  "nullable": false,
  "description": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "pcm16",
  "minimum": null,
  "maximum": null,
  "enum": [
   "pcm16",
   "g711_ulaw",
   "g711_alaw"
  ],
  "nullable": false,
  "description": "The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.\nFor `pcm16`, input audio must be 16-bit PCM at a 24kHz sample rate,\nsingle channel (mono), and little-endian byte order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_transcription",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Configuration for input audio transcription. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_transcription.model",
  "location": "body",
  "type": "string | enum",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "whisper-1",
   "gpt-transcribe",
   "gpt-live-transcribe",
   "gpt-4o-mini-transcribe",
   "gpt-4o-mini-transcribe-2025-12-15",
   "gpt-4o-transcribe",
   "gpt-4o-transcribe-diarize",
   "gpt-realtime-whisper"
  ],
  "nullable": false,
  "description": "The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_transcription.language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_transcription.languages",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_transcription.keywords",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe` and `gpt-live-transcribe`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_transcription.prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the prompt is a free text string, for example \"expect words related to technology\".\nPrompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "input_audio_transcription.delay",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "nullable": false,
  "description": "Controls how long the model waits before emitting transcription text.\nHigher values can improve transcription accuracy at the cost of latency.\nOnly supported with `gpt-realtime-whisper` in GA Realtime sessions.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/transcription_sessions",
  "parameter": "include",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "nullable": false,
  "description": "The set of items to include in the transcription. Current available items are:\n`item.input_audio_transcription.logprobs`",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "BETA",
   "FAILED_VERIFICATION"
  ],
  "source": {
   "url": "https://developers.openai.com/api/reference/realtime-beta/overview",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime (connect)",
  "parameter": "model",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Realtime model to use when opening a fresh WebSocket session with a standard API key (`wss://api.openai.com/v1/realtime?model=…`). Ignored when `call_id` is given.",
  "nullable": false,
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/voice-websockets?api=realtime",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime (connect)",
  "parameter": "call_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Attach a sideband WebSocket to an existing WebRTC/SIP call (`wss://api.openai.com/v1/realtime?call_id=rtc_…`). The model is already configured by the call/accept step.",
  "nullable": false,
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/voice-websockets?api=realtime",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime (connect)",
  "parameter": "Authorization",
  "location": "header",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "`Bearer <standard API key>` (server) or `Bearer <ek_… client secret>` (browser/mobile). In browsers without header support, use WebSocket subprotocols `realtime`, `openai-insecure-api-key.<ek_…>`, optional `openai-organization.<org>`, `openai-project.<proj>`.",
  "nullable": false,
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/voice-websockets?api=realtime",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime (connect)",
  "parameter": "OpenAI-Safety-Identifier",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stable, privacy-preserving end-user identifier (hashed). Set on the server-side connection request or on the client_secrets request (bound to the ephemeral token).",
  "nullable": false,
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/voice-websockets?api=realtime",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/realtime (connect)",
  "parameter": "OpenAI-Beta",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "realtime=v1"
  ],
  "description": "BETA-ERA header only. Remove for the GA interface (docs: 'Remove the OpenAI-Beta: realtime=v1 header when calling the GA interface').",
  "nullable": false,
  "compatible_models": [],
  "beta_header": "realtime=v1",
  "status": [
   "DOCUMENTED"
  ],
  "source": {
   "url": "https://developers.openai.com/api/docs/guides/voice-websockets?api=realtime",
   "retrieved_at": "2026-09-19T01:31:52Z"
  },
  "_fragment": "generated/fragments/parameters/openai-realtime.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "metadata",
  "location": "body",
  "type": "map<string,string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "schema_ref": "Metadata",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "top_logprobs",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 20,
  "enum": null,
  "description": "An integer between 0 and 20 specifying the maximum number of most likely tokens to return at each token position, each with an associated log probability. In some cases, the number of returned tokens may be fewer than requested.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "notes": "Live p7: top_logprobs=1 + include=[\"message.output_text.logprobs\"] returns output_text.logprobs[] with token/logprob/bytes/top_logprobs.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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. We generally recommend altering this or `top_p` but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "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. We generally recommend altering this or `temperature` but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Live: gpt-5.4-nano reports top_p=0.98 when omitted (documented default is 1).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "user",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "notes": "Deprecated: replaced by safety_identifier + prompt_cache_key. Live l10: still accepted.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "safety_identifier",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user, with a maximum length of 64 characters. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt_cache_key",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Live n: same key + same ~1.5k-token prefix twice on gpt-5.4-nano -> cached_tokens=0 both times (no hit within 1.5 s); chat gpt-4.1-nano -> 1408 cached of 1556 on 2nd call.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt_cache_retention",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_memory",
   "24h"
  ],
  "description": "Deprecated. Use `prompt_cache_options.ttl` instead. The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). This field expresses a maximum retention policy, while `prompt_cache_options.ttl` expresses a minimum cache lifetime. The two fields are independent and do not interact. For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported. For older models that support both `in_memory` and `24h`, the default depends on your organization's data retention policy: - Organizations without ZDR enabled default to `24h`. - Organizations with ZDR enabled default to `in_memory` when `prompt_cache_retention` is not specified.",
  "compatible_models": [
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.4",
   "gpt-5.2",
   "gpt-5.1-codex-max",
   "gpt-5.1",
   "gpt-5.1-codex",
   "gpt-5.1-codex-mini",
   "gpt-5.1-chat-latest",
   "gpt-5",
   "gpt-5-codex",
   "gpt-4.1",
   "(in_memory: all cache-capable models)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Deprecated in favour of prompt_cache_options.ttl (GPT-5.6+). Live: response echoes \"24h\" by default and \"in_memory\" when requested.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt_cache_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ResponsePromptCacheOptionsParam",
  "notes": "GPT-5.6+ only. Live p12: gpt-5.4-nano -> 400 invalid_parameter \"prompt_cache_options is not supported on this model\".",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt_cache_options.ttl",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "30m"
  ],
  "description": "The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. Defaults to `30m`, which is currently the only supported value. The backend may retain cache entries for longer.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheTTLEnum",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt_cache_options.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "implicit",
   "explicit"
  ],
  "description": "Controls whether OpenAI automatically creates an implicit cache breakpoint. Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint and writes up to the latest three explicit breakpoints in the request. With `explicit`, OpenAI does not create an implicit breakpoint and writes up to the latest four explicit breakpoints. If there are no explicit breakpoints, the request does not use prompt caching.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheModeEnum",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt_cache_options.prewarm",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Prepares the prompt cache without generating output. Defaults to `false`. When set to `true`, overrides the `generate` field to `false`.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt_cache_options.comparison_response_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of a response to compare when diagnosing prompt cache reuse. Supplying this field requests prompt cache diagnostics when the feature is enabled.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "previous_response_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Mutually exclusive with `conversation` (live p1: 400 mutually_exclusive_parameters). Unknown id -> 400 previous_response_not_found (live p6). Prior turns are re-billed as input tokens.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ModelIdsResponses",
  "notes": "Live models used: gpt-5.4-nano (responses), gpt-4.1-nano (chat/vision), gpt-3.5-turbo-instruct (completions).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "background",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to run the model response in the background. [Learn more](https://developers.openai.com/api/docs/guides/background).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Live j1: response returned immediately with status=\"queued\"; cancel is idempotent (j2/j4). Not supported over WebSocket.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "max_tool_calls",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text) - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ResponseTextParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format",
  "location": "body",
  "type": "object<text> | object<json_schema> | object<json_object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object specifying the format that the model must output. Configuring `{ \"type\": \"json_schema\" }` enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs). The default format is `{ \"type\": \"text\" }` with no additional options. **Not recommended for gpt-4o and newer models:** Setting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which ensures the message the model generates is valid JSON. Using `json_schema` is preferred for models that support it.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "TextResponseFormatConfiguration",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(text)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Default response format. Used to generate text responses.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "text",
  "schema_ref": "ResponseFormatText",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "The type of response format being defined. Always `text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(json_schema)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "json_schema",
  "schema_ref": "TextResponseFormatJsonSchema",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(json_schema).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_schema"
  ],
  "description": "The type of response format being defined. Always `json_schema`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(json_schema).description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of what the response format is for, used by the model to determine how to respond in the format.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(json_schema).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(json_schema).schema",
  "location": "body",
  "type": "map<string,any>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ResponseFormatJsonSchemaSchema",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(json_schema).strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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`. To learn more, read the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Spec default false; guide recommends strict=true. Live e: strict=true honoured and echoed.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(json_object)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "json_object",
  "schema_ref": "ResponseFormatJsonObject",
  "notes": "Live p3: input must contain the word \"json\" or HTTP 400 (\"Response input messages must contain the word 'json' ...\").",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format(json_object).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_object"
  ],
  "description": "The type of response format being defined. Always `json_object`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.verbosity",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. The default is `medium`.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4*",
   "gpt-5.2*",
   "gpt-5.1*",
   "gpt-5*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "schema_ref": "Verbosity",
  "notes": "GPT-5+ only. Live p11: gpt-4.1-nano + verbosity \"low\" -> 400 unsupported_value (\"Supported values are: 'medium'\").",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools",
  "location": "body",
  "type": "array<object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of tools the model may call while generating a response. You can specify which tool to use by setting the `tool_choice` parameter. We support the following categories of tools: - **Built-in tools**: Tools that are provided by OpenAI that extend the model's capabilities, like [web search](https://developers.openai.com/api/docs/guides/tools-web-search) or [file search](https://developers.openai.com/api/docs/guides/tools-file-search). Learn more about [built-in tools](https://developers.openai.com/api/docs/guides/tools). - **MCP Tools**: Integrations with third-party systems via custom MCP servers or predefined connectors such as Google Drive and SharePoint. Learn more about [MCP Tools](https://developers.openai.com/api/docs/guides/tools-connectors-mcp). - **Function calls (custom tools)**: Functions that are defined by you, enabling the model to call your own code with strongly ty",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ToolsArray",
  "notes": "Tool definitions are documented by the tools fragments (generated/fragments/tools/**); only the shape is referenced here.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[]",
  "location": "body",
  "type": "object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that can be used to generate a response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "Tool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](function)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Defines a function in your own code the model can choose to call. Learn more about [function calling](https://developers.openai.com/api/docs/guides/function-calling).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "function",
  "schema_ref": "FunctionTool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](file_search)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "file_search",
  "schema_ref": "FileSearchTool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](computer)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "computer",
  "schema_ref": "ComputerTool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](computer_use_preview)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that controls a virtual computer. Learn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "computer_use_preview",
  "schema_ref": "ComputerUsePreviewTool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](web_search)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Search the Internet for sources related to the prompt. Learn more about the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "WebSearchTool",
  "schema_ref": "WebSearchTool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](mcp)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Give the model access to additional tools via remote Model Context Protocol (MCP) servers. [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "mcp",
  "schema_ref": "MCPTool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](code_interpreter)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that runs Python code to help generate a response to a prompt.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "code_interpreter",
  "schema_ref": "CodeInterpreterTool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](programmatic_tool_calling)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "programmatic_tool_calling",
  "schema_ref": "ProgrammaticToolCallingParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](image_generation)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that generates images using the GPT image models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "image_generation",
  "schema_ref": "ImageGenTool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](local_shell)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that allows the model to execute shell commands in a local environment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "local_shell",
  "schema_ref": "LocalShellToolParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](shell)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that allows the model to execute shell commands.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "shell",
  "schema_ref": "FunctionShellToolParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](custom)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A custom tool that processes input using a specified format. Learn more about [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "custom",
  "schema_ref": "CustomToolParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](namespace)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Groups function/custom tools under a shared namespace.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "namespace",
  "schema_ref": "NamespaceToolParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](tool_search)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Hosted or BYOT tool search configuration for deferred tools.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "tool_search",
  "schema_ref": "ToolSearchToolParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](web_search_preview)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "WebSearchPreviewTool",
  "schema_ref": "WebSearchPreviewTool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[](apply_patch)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Allows the assistant to create, delete, or update files using unified diffs.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "apply_patch",
  "schema_ref": "ApplyPatchToolParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice",
  "location": "body",
  "type": "string | object<allowed_tools> | ToolChoiceTypes | object<function> | object<mcp> | object<custom> | object<programmatic_tool_calling> | object<apply_patch> | object<shell>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "How the model should select which tool (or tools) to use when generating a response. See the `tools` parameter to see how to specify which tools the model can call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ToolChoiceParam",
  "notes": "Detailed per-tool tool_choice objects are documented by the tools fragments.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(allowed_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Constrains the tools available to the model to a pre-defined set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "allowed_tools",
  "schema_ref": "ToolChoiceAllowed",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(allowed_tools).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "allowed_tools"
  ],
  "description": "Allowed tool configuration type. Always `allowed_tools`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(allowed_tools).mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "required"
  ],
  "description": "Constrains the tools available to the model to a pre-defined set. `auto` allows the model to pick from among the allowed tools and generate a message. `required` requires the model to call one or more of the allowed tools.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(allowed_tools).tools",
  "location": "body",
  "type": "array<map<string,any>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tool definitions that the model should be allowed to call. For the Responses API, the list of tool definitions might look like: ```json [ { \"type\": \"function\", \"name\": \"get_weather\" }, { \"type\": \"mcp\", \"server_label\": \"deepwiki\" }, { \"type\": \"image_generation\" } ] ```",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(allowed_tools).tools[]",
  "location": "body",
  "type": "map<string,any>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool definition that the model should be allowed to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(hosted_tool)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "ToolChoiceTypes",
  "schema_ref": "ToolChoiceTypes",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(hosted_tool).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "file_search",
   "web_search_preview",
   "computer",
   "computer_use_preview",
   "computer_use",
   "web_search_preview_2025_03_11",
   "image_generation",
   "code_interpreter"
  ],
  "description": "The type of hosted tool the model should to use. Learn more about [built-in tools](https://developers.openai.com/api/docs/guides/tools). Allowed values are: - `file_search` - `web_search_preview` - `computer` - `computer_use_preview` - `computer_use` - `code_interpreter` - `image_generation`",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(function)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Use this option to force the model to call a specific function.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "function",
  "schema_ref": "ToolChoiceFunction",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(function).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": "For function calling, the type is always `function`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(function).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(mcp)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Use this option to force the model to call a specific tool on a remote MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "mcp",
  "schema_ref": "ToolChoiceMCP",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(mcp).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp"
  ],
  "description": "For MCP tools, the type is always `mcp`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(mcp).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server to use.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(mcp).name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool to call on the server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(custom)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Use this option to force the model to call a specific custom tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "custom",
  "schema_ref": "ToolChoiceCustom",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(custom).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom"
  ],
  "description": "For custom tool calling, the type is always `custom`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(custom).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the custom tool to call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(programmatic_tool_calling)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "programmatic_tool_calling",
  "schema_ref": "SpecificProgrammaticToolCallingParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(programmatic_tool_calling).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "programmatic_tool_calling",
  "minimum": null,
  "maximum": null,
  "enum": [
   "programmatic_tool_calling"
  ],
  "description": "The tool to call. Always `programmatic_tool_calling`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(apply_patch)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Forces the model to call the apply_patch tool when executing a tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "apply_patch",
  "schema_ref": "SpecificApplyPatchParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(apply_patch).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "apply_patch",
  "minimum": null,
  "maximum": null,
  "enum": [
   "apply_patch"
  ],
  "description": "The tool to call. Always `apply_patch`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(shell)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Forces the model to call the shell tool when a tool call is required.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "shell",
  "schema_ref": "SpecificFunctionShellParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice(shell).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "shell",
  "minimum": null,
  "maximum": null,
  "enum": [
   "shell"
  ],
  "description": "The tool to call. Always `shell`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reference to a prompt template and its variables. [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "schema_ref": "Prompt",
  "notes": "Prompt templates (reusable prompts from the dashboard); variables may be strings or input_text/input_image/input_file parts.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt.id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique identifier of the prompt template to use.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt.version",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional version of the prompt template.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt.variables",
  "location": "body",
  "type": "map<string,string | object<input_text> | object<input_image> | object<input_file>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "schema_ref": "ResponsePromptVariables",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "service_tier",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "flex",
   "scale",
   "priority",
   "fast",
   "ultrafast"
  ],
  "description": "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. - If set to 'ultrafast', then the request will",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "schema_ref": "ServiceTierResponses",
  "notes": "Requested \"auto\" is echoed as the effective tier (\"default\" live). fast/priority/flex/scale availability depends on model & account.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "truncation",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "disabled",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "disabled"
  ],
  "description": "The truncation strategy to use for the model response. - `auto`: If the input to this Response exceeds the model's context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation. - `disabled` (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Marked deprecated in the OpenAPI spec (CreateResponse) but still accepted and echoed (live p7: truncation=\"auto\"). Use context_management (compaction) instead.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration options for [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Controls the reasoning execution mode for the request. When returned on a response, this is the effective execution mode.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ReasoningModeEnum",
  "notes": "Enum from ReasoningModeEnum: standard | pro (GPT-5.6 models). Live: response echoes mode=\"standard\" on gpt-5.4-nano.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning.effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "Constrains effort on reasoning for reasoning models. Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for model-specific support.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "schema_ref": "ReasoningEffort",
  "notes": "Live: gpt-5.4-nano echoes effort=\"none\" when omitted (response.reasoning.effort). gpt-6-astra rejects \"none\" with HTTP 400 (guide). gpt-4.1-nano returns 400 unsupported_parameter (live p5).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning.summary",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "concise",
   "detailed"
  ],
  "description": "A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`. `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Live: summary=\"auto\" is echoed back as \"detailed\" on gpt-5.4-nano; summary items only appear when the model actually reasons (f3: 118 reasoning tokens -> 1 summary_text).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning.context",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "current_turn",
   "all_turns"
  ],
  "description": "Controls which reasoning items are rendered back to the model on later turns. If omitted or set to `auto`, the model determines the context mode. The `gpt-5.6` model family defaults to `all_turns`; earlier models default to `current_turn`. When returned on a response, this is the effective reasoning context mode used for the response.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "GPT-5.6 family defaults to all_turns; earlier models default to current_turn. Live: gpt-5.4-nano echoes context=\"current_turn\".",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning.generate_summary",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "concise",
   "detailed"
  ],
  "description": "**Deprecated:** use `summary` instead. A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input",
  "location": "body",
  "type": "string | array<object<message> | object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or file inputs to the model, used to generate a response. Learn more: - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text) - [Image inputs](https://developers.openai.com/api/docs/guides/images-vision) - [File inputs](https://developers.openai.com/api/docs/guides/file-inputs) - [Conversation state](https://developers.openai.com/api/docs/guides/conversation-state) - [Function calling](https://developers.openai.com/api/docs/guides/function-calling)",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "InputParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[]",
  "location": "body",
  "type": "array<object<message> | object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>> | object<program_output>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of one or many input items to the model, containing different content types.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A message input to the model with a role indicating instruction following hierarchy. Instructions given with the `developer` or `system` role take precedence over instructions given with the `user` role. Messages with the `assistant` role are presumed to have been generated by the model in previous interactions.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "message",
  "schema_ref": "EasyInputMessage",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user",
   "assistant",
   "system",
   "developer"
  ],
  "description": "The role of the message input. One of `user`, `assistant`, `system`, or `developer`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content",
  "location": "body",
  "type": "string | array<object<input_text> | object<input_image> | object<input_file>> | array<object<output_text> | object<refusal>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[]",
  "location": "body",
  "type": "array<object<input_text> | object<input_image> | object<input_file>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of one or many input items to the model, containing different content types.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "InputMessageContentList",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).phase",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "commentary",
   "final_answer"
  ],
  "description": "Labels an `assistant` message as intermediate commentary (`commentary`) or the final answer (`final_answer`). For models like `gpt-5.3-codex` and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Live 2026-09-18: assistant output messages from gpt-5.4-nano carry phase=\"final_answer\"; guide recommends round-tripping phase on GPT-5.4/5.5.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "message"
  ],
  "description": "The type of the message input. Always `message`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the output message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](file_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a file search tool call. See the [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "file_search_call",
  "schema_ref": "FileSearchToolCall",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](file_search_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the file search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](file_search_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "file_search_call"
  ],
  "description": "The type of the file search tool call. Always `file_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](file_search_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "searching",
   "completed",
   "incomplete",
   "failed"
  ],
  "description": "The status of the file search tool call. One of `in_progress`, `searching`, `incomplete` or `failed`,",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](file_search_call).queries",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The queries used to search for files.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](file_search_call).results",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of the file search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to a computer use tool. See the [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "computer_call",
  "schema_ref": "ComputerToolCall",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_call"
  ],
  "description": "The type of the computer call. Always `computer_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An identifier used when responding to the tool call with output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call).action",
  "location": "body",
  "type": "object<click> | object<double_click> | object<drag> | object<keypress> | object<move> | object<screenshot> | object<scroll> | object<type> | object<wait>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ComputerAction",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call).actions",
  "location": "body",
  "type": "array<object<click> | object<double_click> | object<drag> | object<keypress> | object<move> | object<screenshot> | object<scroll> | object<type> | object<wait>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Flattened batched actions for `computer_use`. Each action includes an `type` discriminator and action-specific fields.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ComputerActionList",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call).pending_safety_checks",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The pending safety checks for the computer call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a computer tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "computer_call_output",
  "schema_ref": "ComputerCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the computer tool call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the computer tool call that produced the output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_call_output"
  ],
  "description": "The type of the computer tool call output. Always `computer_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call_output).output",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A computer screenshot image used with the computer use tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ComputerScreenshotImage",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call_output).acknowledged_safety_checks",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The safety checks reported by the API that have been acknowledged by the developer.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](computer_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the message input. One of `in_progress`, `completed`, or `incomplete`. Populated when input items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](web_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a web search tool call. See the [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "web_search_call",
  "schema_ref": "WebSearchToolCall",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](web_search_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the web search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](web_search_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search_call"
  ],
  "description": "The type of the web search tool call. Always `web_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](web_search_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "searching",
   "completed",
   "failed",
   "incomplete"
  ],
  "description": "The status of the web search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "WebSearchCallStatus",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](web_search_call).action",
  "location": "body",
  "type": "object<search> | object<open_page> | object<find_in_page>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a function. See the [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "function_call",
  "schema_ref": "FunctionToolCall",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call).id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function_call"
  ],
  "description": "The type of the function tool call. Always `function_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call).namespace",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace of the function to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call).arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the arguments to pass to the function.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call).status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call).async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the function tool call runs asynchronously.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "function_call_output",
  "schema_ref": "FunctionCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call output. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "function_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function_call_output"
  ],
  "description": "The type of the function tool call output. Always `function_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output",
  "location": "body",
  "type": "string | array<object<input_text> | object<input_image> | object<input_file>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or file output of the function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool that produced the output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).namespace",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace of the tool that produced the output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "tool_search_call",
  "schema_ref": "ToolSearchCallItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_call).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this tool search call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_call).call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool search call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "tool_search_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_call"
  ],
  "description": "The item type. Always `tool_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_call).execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server",
   "client"
  ],
  "description": "Whether tool search was executed by the server or by the client.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ToolSearchExecutionType",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_call).arguments",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The arguments supplied to the tool search call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "EmptyModelParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_call).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the tool search call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "tool_search_output",
  "schema_ref": "ToolSearchOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this tool search output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_output).call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool search call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "tool_search_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_output"
  ],
  "description": "The item type. Always `tool_search_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_output).execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server",
   "client"
  ],
  "description": "Whether tool search was executed by the server or by the client.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ToolSearchExecutionType",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_output).tools",
  "location": "body",
  "type": "array<object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The loaded tool definitions returned by the tool search output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](tool_search_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the tool search output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](additional_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "additional_tools",
  "schema_ref": "AdditionalToolsItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](additional_tools).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this additional tools item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](additional_tools).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "additional_tools",
  "minimum": null,
  "maximum": null,
  "enum": [
   "additional_tools"
  ],
  "description": "The item type. Always `additional_tools`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](additional_tools).role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "developer",
  "minimum": null,
  "maximum": null,
  "enum": [
   "developer"
  ],
  "description": "The role that provided the additional tools. Only `developer` is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](additional_tools).tools",
  "location": "body",
  "type": "array<object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of additional tools made available at this item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](configuration_update)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An update to the conversation's response configuration. The configuration remains in effect for subsequent responses until it is replaced by another configuration update.",
  "compatible_models": [
   "gpt-6-astra"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "configuration_update",
  "schema_ref": "ResponseConfigurationUpdateItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](configuration_update).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the configuration update item.",
  "compatible_models": [
   "gpt-6-astra"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](configuration_update).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "configuration_update",
  "minimum": null,
  "maximum": null,
  "enum": [
   "configuration_update"
  ],
  "description": "The item type. Always `configuration_update`.",
  "compatible_models": [
   "gpt-6-astra"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](configuration_update).reasoning",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updates to reasoning configuration. Only effort is supported.",
  "compatible_models": [
   "gpt-6-astra"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](reasoning)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your `input` to the Responses API for subsequent turns of a conversation if you are manually [managing context](https://developers.openai.com/api/docs/guides/conversation-state).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "reasoning",
  "schema_ref": "ReasoningItem",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](reasoning).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "reasoning"
  ],
  "description": "The type of the object. Always `reasoning`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](reasoning).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique identifier of the reasoning content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](reasoning).encrypted_content",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The encrypted content of the reasoning item. This is populated by default for reasoning items returned by `POST /v1/responses` and WebSocket `response.create` requests. When streaming, use the completed reasoning item and its `encrypted_content` from the `response.output_item.done` event in subsequent requests. The `encrypted_content` in `response.output_item.added` may be incomplete. This is especially important when `store` is `false` or when using Zero Data Retention.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](reasoning).summary",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning summary content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](reasoning).content",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](reasoning).status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](compaction)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).",
  "compatible_models": [
   "* (responses models supporting compaction)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "compaction",
  "schema_ref": "CompactionSummaryItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](compaction).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the compaction item.",
  "compatible_models": [
   "* (responses models supporting compaction)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](compaction).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "compaction",
  "minimum": null,
  "maximum": null,
  "enum": [
   "compaction"
  ],
  "description": "The type of the item. Always `compaction`.",
  "compatible_models": [
   "* (responses models supporting compaction)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](compaction).encrypted_content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The encrypted content of the compaction summary.",
  "compatible_models": [
   "* (responses models supporting compaction)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image generation request made by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "image_generation_call",
  "schema_ref": "ImageGenToolCall",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image_generation_call"
  ],
  "description": "The type of the image generation call. Always `image_generation_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the image generation call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "generating",
   "failed"
  ],
  "description": "The status of the image generation call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).result",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The generated image encoded in base64.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).size",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).quality",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max",
   "auto"
  ],
  "description": "The quality of the image generated by the image generation tool call. One of `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).action",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "generate",
   "edit",
   "auto"
  ],
  "description": "The action used for image generation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).background",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "transparent",
   "opaque",
   "auto"
  ],
  "description": "The background setting used for generation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).output_format",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "png",
   "webp",
   "jpeg"
  ],
  "description": "The output format used for generation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](image_generation_call).revised_prompt",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The prompt that was used after any model prompt rewriting.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](code_interpreter_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run code.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "code_interpreter_call",
  "schema_ref": "CodeInterpreterToolCall",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](code_interpreter_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "code_interpreter_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "code_interpreter_call"
  ],
  "description": "The type of the code interpreter tool call. Always `code_interpreter_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](code_interpreter_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the code interpreter tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](code_interpreter_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete",
   "interpreting",
   "failed"
  ],
  "description": "The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](code_interpreter_call).container_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the container used to run the code.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](code_interpreter_call).code",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The code to run, or null if not available.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](code_interpreter_call).outputs",
  "location": "body",
  "type": "array<object<logs> | object<image>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a command on the local shell.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "local_shell_call",
  "schema_ref": "LocalShellToolCall",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "local_shell_call"
  ],
  "description": "The type of the local shell call. Always `local_shell_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the local shell call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the local shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call).action",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Execute a shell command on the server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "LocalShellExecAction",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the local shell call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a local shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "local_shell_call_output",
  "schema_ref": "LocalShellToolCallOutput",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "local_shell_call_output"
  ],
  "description": "The type of the local shell tool call output. Always `local_shell_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call_output).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the local shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call_output).output",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the output of the local shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](local_shell_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the item. One of `in_progress`, `completed`, or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool representing a request to execute one or more shell commands.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "shell_call",
  "schema_ref": "FunctionShellCallItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "shell_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "shell_call"
  ],
  "description": "The type of the item. Always `shell_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call).action",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The shell commands and limits that describe how to run the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "FunctionShellActionParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the shell call. One of `in_progress`, `completed`, or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call).environment",
  "location": "body",
  "type": "object<local> | object<container_reference>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The environment to execute the shell commands in.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output items emitted by a shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "shell_call_output",
  "schema_ref": "FunctionShellCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call output. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "shell_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "shell_call_output"
  ],
  "description": "The type of the item. Always `shell_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call_output).output",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Captured chunks of stdout and stderr output, along with their associated outcomes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call_output).status",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete"
  ],
  "description": "The status of the shell call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](shell_call_output).max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of UTF-8 characters captured for this shell call's combined output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call representing a request to create, delete, or update files using diff patches.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "apply_patch_call",
  "schema_ref": "ApplyPatchToolCallItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "apply_patch_call",
  "minimum": null,
  "maximum": null,
  "enum": [
   "apply_patch_call"
  ],
  "description": "The type of the item. Always `apply_patch_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed"
  ],
  "description": "The status of the apply patch tool call. One of `in_progress` or `completed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ApplyPatchCallStatusParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call).operation",
  "location": "body",
  "type": "object<create_file> | object<delete_file> | object<update_file>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The specific create, delete, or update instruction for the apply_patch tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ApplyPatchOperationParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output emitted by an apply patch tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "apply_patch_call_output",
  "schema_ref": "ApplyPatchToolCallOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "apply_patch_call_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "apply_patch_call_output"
  ],
  "description": "The type of the item. Always `apply_patch_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call_output).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call output. Populated when this item is returned via API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the apply patch tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call_output).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "completed",
   "failed"
  ],
  "description": "The status of the apply patch tool call output. One of `completed` or `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ApplyPatchCallOutputStatusParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](apply_patch_call_output).output",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional human-readable log text from the apply patch tool (e.g., patch results or errors).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_list_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools available on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "mcp_list_tools",
  "schema_ref": "MCPListTools",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_list_tools).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_list_tools"
  ],
  "description": "The type of the item. Always `mcp_list_tools`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_list_tools).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the list.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_list_tools).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_list_tools).tools",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tools available on the server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_list_tools).error",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Error message if the server could not list tools.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_request)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A request for human approval of a tool invocation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "mcp_approval_request",
  "schema_ref": "MCPApprovalRequest",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_request).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_approval_request"
  ],
  "description": "The type of the item. Always `mcp_approval_request`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_request).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the approval request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_request).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server making the request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_request).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_request).arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of arguments for the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_response)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A response to an MCP approval request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "mcp_approval_response",
  "schema_ref": "MCPApprovalResponse",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_response).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_approval_response"
  ],
  "description": "The type of the item. Always `mcp_approval_response`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_response).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the approval response",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_response).approval_request_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the approval request being answered.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_response).approve",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the request was approved.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_approval_response).reason",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional reason for the decision.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An invocation of a tool on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "mcp_call",
  "schema_ref": "MCPToolCall",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp_call"
  ],
  "description": "The type of the item. Always `mcp_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call).server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server running the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool that was run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call).arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the arguments passed to the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call).output",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output from the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call).error",
  "location": "body",
  "type": "object<mcp_protocol_error> | object<mcp_tool_execution_error> | object<http_error>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The error from the tool call, if any.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call).status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "incomplete",
   "calling",
   "failed"
  ],
  "description": "The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `calling`, or `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "MCPToolCallStatus",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](mcp_call).approval_request_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique identifier for the MCP tool call approval request. Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a custom tool call from your code, being sent back to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "custom_tool_call_output",
  "schema_ref": "CustomToolCallOutput",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom_tool_call_output"
  ],
  "description": "The type of the custom tool call output. Always `custom_tool_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the custom tool call output in the OpenAI platform.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The call ID, used to map this custom tool call output to a custom tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output",
  "location": "body",
  "type": "string | array<object<input_text> | object<input_image> | object<input_file>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output from the custom tool call generated by your code. Can be a string or an list of output content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A call to a custom tool created by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "custom_tool_call",
  "schema_ref": "CustomToolCall",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom_tool_call"
  ],
  "description": "The type of the custom tool call. Always `custom_tool_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call).id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the custom tool call in the OpenAI platform.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An identifier used to map this custom tool call to a tool call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call).caller",
  "location": "body",
  "type": "object<direct> | object<program>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The execution context that produced this tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call).namespace",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace of the custom tool being called.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call).name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the custom tool being called.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call).input",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input for the custom tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call).async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the custom tool call runs asynchronously.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](compaction_trigger)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Compacts the current context. Must be the final input item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "compaction_trigger",
  "schema_ref": "CompactionTriggerItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](compaction_trigger).id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this compaction trigger.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](compaction_trigger).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "compaction_trigger",
  "minimum": null,
  "maximum": null,
  "enum": [
   "compaction_trigger"
  ],
  "description": "The type of the item. Always `compaction_trigger`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](item_reference)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An internal identifier for an item to reference.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "ItemReferenceParam",
  "schema_ref": "ItemReferenceParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](item_reference).type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "item_reference",
  "minimum": null,
  "maximum": null,
  "enum": [
   "item_reference"
  ],
  "description": "The type of item to reference. Always `item_reference`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](item_reference).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the item to reference.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "program",
  "schema_ref": "ProgramItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "program",
  "minimum": null,
  "maximum": null,
  "enum": [
   "program"
  ],
  "description": "The item type. Always `program`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The stable call ID of the program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program).code",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The JavaScript source executed by programmatic tool calling.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program).fingerprint",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque program replay fingerprint that must be round-tripped.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "program_output",
  "schema_ref": "ProgramOutputItemParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program_output).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of this program output item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program_output).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "program_output",
  "minimum": null,
  "maximum": null,
  "enum": [
   "program_output"
  ],
  "description": "The item type. Always `program_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program_output).call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The call ID of the program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program_output).result",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The result produced by the program item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](program_output).status",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "completed",
   "incomplete"
  ],
  "description": "The terminal status of the program output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ProgramOutputItemStatus",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "include",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specify additional output data to include in the model response. Currently supported values are: - `web_search_call.action.sources`: Include the sources of the web search tool call. - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. - `computer_call_output.output.image_url`: Include image urls from the computer call output. - `file_search_call.results`: Include the search results of the file search tool call. - `message.input_image.image_url`: Include image urls from the input message. - `message.output_text.logprobs`: Include logprobs with assistant messages. - `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `fal",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "include[]",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "file_search_call.results",
   "web_search_call.results",
   "web_search_call.action.sources",
   "message.input_image.image_url",
   "computer_call_output.output.image_url",
   "code_interpreter_call.outputs",
   "reasoning.encrypted_content",
   "message.output_text.logprobs"
  ],
  "description": "Specify additional output data to include in the model response. Currently supported values are: - `web_search_call.results`: Include the search results of the web search tool call. - `web_search_call.action.sources`: Include the sources of the web search tool call. - `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items. - `computer_call_output.output.image_url`: Include image urls from the computer call output. - `file_search_call.results`: Include the search results of the file search tool call. - `message.input_image.image_url`: Include image urls from the input message. - `message.output_text.logprobs`: Include logprobs with assistant messages. - `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations whe",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "IncludeEnum",
  "notes": "Live g3/p7: message.output_text.logprobs accepted on create and retrieve; reasoning.encrypted_content is now populated by default when store=false (legacy include value still accepted).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to allow the model to run tool calls in parallel.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "store",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to store the generated model response for later retrieval via API. Defaults to true when omitted. If set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](https://developers.openai.com/api/docs/guides/your-data#v1responses).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Default true for Responses (30-day retention); store=false responses cannot be retrieved (live d2: GET -> 404). Chat Completions default is false.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A system (or developer) message inserted into the model's context. When using along with `previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "moderation",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for running moderation on the input and output of this response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "moderation.model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The moderation model to use for moderated completions, e.g. 'omni-moderation-latest'.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "moderation.policy",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The policy to apply to moderated response input and output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "moderation.policy.input",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The moderation policy for the response input.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "moderation.policy.input.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "score",
   "block"
  ],
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ModerationMode",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "moderation.policy.output",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The moderation policy for the response output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "moderation.policy.output.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "score",
   "block"
  ],
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ModerationMode",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "SSE; event names equal data.type. Live sequence for plain text: response.created, response.in_progress, response.output_item.added, response.content_part.added, response.output_text.delta*, response.output_text.done, response.content_part.done, response.output_item.done, response.completed. Background streams add response.queued.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "stream_options",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Options for streaming responses. Only set this when you set `stream: true`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "schema_ref": "ResponseStreamOptions",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "stream_options.include_obfuscation",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an `obfuscation` field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set `include_obfuscation` to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "conversation",
  "location": "body",
  "type": "string | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The conversation that this response belongs to. Items from this conversation are prepended to `input_items` for this response request. Input items and output items from this response are automatically added to this conversation after this response completes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Mutually exclusive with previous_response_id. Accepts a string id or {\"id\": ...}; response echoes {\"id\": \"conv_...\"}. Items of the response are appended to the conversation (live k6).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "conversation(object)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The conversation that this response belongs to.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "ConversationParam-2",
  "schema_ref": "ConversationParam-2",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "conversation(object).id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the conversation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "context_management",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Context management configuration for this request.",
  "compatible_models": [
   "* (responses models supporting compaction, e.g. gpt-5.3-codex, gpt-5.4*, gpt-6-astra)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "context_management[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "* (responses models supporting compaction, e.g. gpt-5.3-codex, gpt-5.4*, gpt-6-astra)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ContextManagementParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "context_management[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The context management entry type. Currently only 'compaction' is supported.",
  "compatible_models": [
   "* (responses models supporting compaction, e.g. gpt-5.3-codex, gpt-5.4*, gpt-6-astra)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "context_management[].compact_threshold",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 1000,
  "maximum": null,
  "enum": null,
  "description": "Token threshold at which compaction should be triggered for this entry.",
  "compatible_models": [
   "* (responses models supporting compaction, e.g. gpt-5.3-codex, gpt-5.4*, gpt-6-astra)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "max_output_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 16,
  "maximum": null,
  "enum": null,
  "description": "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](https://developers.openai.com/api/docs/guides/reasoning).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "notes": "Live p2: value 8 -> HTTP 400 integer_below_min_value (minimum 16). Includes reasoning + formatting tokens; a 32-token budget was fully consumed by reasoning at effort=medium (f2 -> status incomplete, reason max_output_tokens).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_text)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "input_text",
  "schema_ref": "InputTextContent",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text"
  ],
  "description": "The type of the input item. Always `input_text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_image)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "input_image",
  "schema_ref": "InputImageContent",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_image).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_image",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": "The type of the input item. Always `input_image`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_image).image_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_image).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_image).detail",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "high",
   "auto",
   "original"
  ],
  "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ImageDetail",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_image).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_image).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_file)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A file input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "input_file",
  "schema_ref": "InputFileContent",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_file).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_file",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_file"
  ],
  "description": "The type of the input item. Always `input_file`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_file).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_file).filename",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_file).file_data",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_file).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_file).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_file).file_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](input_file).detail",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "high"
  ],
  "description": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "FileInputDetail",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "output_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "output_text"
  ],
  "description": "The type of the output text. Always `output_text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text output from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).annotations",
  "location": "body",
  "type": "array<object<file_citation> | object<url_citation> | object<container_file_citation> | object<file_path>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The annotations of the text output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).annotations[]",
  "location": "body",
  "type": "object<file_citation> | object<url_citation> | object<container_file_citation> | object<file_path>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An annotation that applies to a span of output text.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "Annotation",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).annotations[](file_citation)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A citation to a file.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "file_citation",
  "schema_ref": "FileCitationBody",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).annotations[](url_citation)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A citation for a web resource used to generate a model response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "url_citation",
  "schema_ref": "UrlCitationBody",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).annotations[](container_file_citation)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A citation for a container file used to generate a model response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "container_file_citation",
  "schema_ref": "ContainerFileCitationBody",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).annotations[](file_path)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A path to a file.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "file_path",
  "schema_ref": "FilePath",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).logprobs",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).logprobs[]",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The log probability of a token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "LogProb",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).logprobs[].token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).logprobs[].logprob",
  "location": "body",
  "type": "number",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).logprobs[].bytes",
  "location": "body",
  "type": "array<integer>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](output_text).logprobs[].top_logprobs",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](refusal).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "refusal",
  "minimum": null,
  "maximum": null,
  "enum": [
   "refusal"
  ],
  "description": "The type of the refusal. Always `refusal`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](message).content[](refusal).refusal",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The refusal explanation from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_text)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "input_text",
  "schema_ref": "InputTextContent",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text"
  ],
  "description": "The type of the input item. Always `input_text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_image)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "input_image",
  "schema_ref": "InputImageContent",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_image).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_image",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": "The type of the input item. Always `input_image`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_image).image_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_image).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_image).detail",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "high",
   "auto",
   "original"
  ],
  "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ImageDetail",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_image).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_image).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_file)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A file input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "input_file",
  "schema_ref": "InputFileContent",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_file).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_file",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_file"
  ],
  "description": "The type of the input item. Always `input_file`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_file).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_file).filename",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_file).file_data",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_file).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_file).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_file).file_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](function_call_output).output[](input_file).detail",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "high"
  ],
  "description": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "FileInputDetail",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_text)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "input_text",
  "schema_ref": "InputTextContent",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_text).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text"
  ],
  "description": "The type of the input item. Always `input_text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_text).text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_text).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_text).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_image)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image input to the model. Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "input_image",
  "schema_ref": "InputImageContent",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_image).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_image",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": "The type of the input item. Always `input_image`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_image).image_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_image).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_image).detail",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "high",
   "auto",
   "original"
  ],
  "description": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "ImageDetail",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_image).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_image).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_file)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A file input to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "variant": "input_file",
  "schema_ref": "InputFileContent",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_file).type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "input_file",
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_file"
  ],
  "description": "The type of the input item. Always `input_file`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_file).file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_file).filename",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_file).file_data",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_file).prompt_cache_breakpoint",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "PromptCacheBreakpointConfig",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_file).prompt_cache_breakpoint.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "explicit",
  "minimum": null,
  "maximum": null,
  "enum": [
   "explicit"
  ],
  "description": "The breakpoint mode. Always `explicit`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_file).file_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the file to be sent to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[](custom_tool_call_output).output[](input_file).detail",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low",
   "high"
  ],
  "description": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "schema_ref": "FileInputDetail",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "personality",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "friendly",
   "pragmatic"
  ],
  "description": "A model-owned style preset to apply to this request (PersonalityEnum). Not listed in the CreateResponse schema; documented for POST /v1/responses/input_tokens.",
  "compatible_models": [
   "unknown"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "notes": "Documented only in the TokenCountsBody schema (PersonalityEnum: friendly | pragmatic). Live p10 (2026-09-18): accepted by POST /v1/responses on gpt-5.4-nano (HTTP 200) and echoed as `personality: null` in the Response object -> LIVE_DISCOVERED for create.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/responses (response.create)",
  "parameter": "stream_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 256,
  "enum": null,
  "description": "WebSocket-only lane identifier (1-256 chars, [A-Za-z0-9_.-]). Requests with the same stream_id run FIFO; different lanes run concurrently (max 16 in-flight, 32 distinct named lanes per connection). Not accepted on HTTP POST /v1/responses.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/websocket-mode",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "WS /v1/responses (response.create)",
  "parameter": "generate",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "WebSocket warm-up: `generate: false` prepares request state (tools, instructions) without producing output; returns a response id usable as previous_response_id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/websocket-mode",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses?beta=true",
  "parameter": "multi_agent",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration for server-hosted multi-agent execution.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses?beta=true",
  "parameter": "multi_agent.enabled",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable server-hosted multi-agent execution for this response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses?beta=true",
  "parameter": "multi_agent.max_concurrent_subagents",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "`max_concurrent_subagents` sets the maximum number of subagents that can be active simultaneously across the entire agent tree. It includes all descendants—children, grandchildren, and deeper subagents—but excludes the root agent. The API does not impose a fixed upper bound on this setting. The default is `3`, which is recommended for most workloads. Multi-agent runs also have no fixed limit on tree depth or the total number of subagents created during a run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "BETA"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/create",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/responses/{response_id}",
  "parameter": "include",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional fields to include in the response. See the `include` parameter for Response creation above for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/responses/{response_id}",
  "parameter": "stream",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section below](https://developers.openai.com/api/reference/resources/responses/streaming-events) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/responses/{response_id}",
  "parameter": "starting_after",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The sequence number of the event after which to start streaming.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/responses/{response_id}",
  "parameter": "include_obfuscation",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an `obfuscation` field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set `include_obfuscation` to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/retrieve",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/responses/{response_id}/input_items",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_items/methods/list",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/responses/{response_id}/input_items",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "The order to return the input items in. Default is `desc`. - `asc`: Return the input items in ascending order. - `desc`: Return the input items in descending order.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_items/methods/list",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/responses/{response_id}/input_items",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An item ID to list items after, used in pagination.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_items/methods/list",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/responses/{response_id}/input_items",
  "parameter": "include",
  "location": "query",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional fields to include in the response. See the `include` parameter for Response creation above for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_items/methods/list",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "model",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "notes": "Live models used: gpt-5.4-nano (responses), gpt-4.1-nano (chat/vision), gpt-3.5-turbo-instruct (completions).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input",
  "location": "body",
  "type": "string | array<object<message> | object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or file inputs to the model, used to generate a response",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[]",
  "location": "body",
  "type": "array<object<message> | object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>> | object<program_output>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of one or many input items to the model, containing different content types.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](message)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A message input to the model with a role indicating instruction following hierarchy. Instructions given with the `developer` or `system` role take precedence over instructions given with the `user` role. Messages with the `assistant` role are presumed to have been generated by the model in previous interactions.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "message",
  "schema_ref": "EasyInputMessage",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](file_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a file search tool call. See the [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "file_search_call",
  "schema_ref": "FileSearchToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](computer_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to a computer use tool. See the [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "computer_call",
  "schema_ref": "ComputerToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](computer_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a computer tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "computer_call_output",
  "schema_ref": "ComputerCallOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](web_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a web search tool call. See the [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "web_search_call",
  "schema_ref": "WebSearchToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](function_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a function. See the [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "function_call",
  "schema_ref": "FunctionToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](function_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "function_call_output",
  "schema_ref": "FunctionCallOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](tool_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "tool_search_call",
  "schema_ref": "ToolSearchCallItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](tool_search_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "tool_search_output",
  "schema_ref": "ToolSearchOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](additional_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "additional_tools",
  "schema_ref": "AdditionalToolsItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](configuration_update)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An update to the conversation's response configuration. The configuration remains in effect for subsequent responses until it is replaced by another configuration update.",
  "compatible_models": [
   "gpt-6-astra"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "configuration_update",
  "schema_ref": "ResponseConfigurationUpdateItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](reasoning)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your `input` to the Responses API for subsequent turns of a conversation if you are manually [managing context](https://developers.openai.com/api/docs/guides/conversation-state).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "reasoning",
  "schema_ref": "ReasoningItem",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](compaction)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).",
  "compatible_models": [
   "* (responses models supporting compaction)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "compaction",
  "schema_ref": "CompactionSummaryItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](image_generation_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image generation request made by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "image_generation_call",
  "schema_ref": "ImageGenToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](code_interpreter_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run code.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "code_interpreter_call",
  "schema_ref": "CodeInterpreterToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](local_shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a command on the local shell.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "local_shell_call",
  "schema_ref": "LocalShellToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](local_shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a local shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "local_shell_call_output",
  "schema_ref": "LocalShellToolCallOutput",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool representing a request to execute one or more shell commands.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "shell_call",
  "schema_ref": "FunctionShellCallItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output items emitted by a shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "shell_call_output",
  "schema_ref": "FunctionShellCallOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](apply_patch_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call representing a request to create, delete, or update files using diff patches.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "apply_patch_call",
  "schema_ref": "ApplyPatchToolCallItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](apply_patch_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output emitted by an apply patch tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "apply_patch_call_output",
  "schema_ref": "ApplyPatchToolCallOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](mcp_list_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools available on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "mcp_list_tools",
  "schema_ref": "MCPListTools",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](mcp_approval_request)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A request for human approval of a tool invocation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "mcp_approval_request",
  "schema_ref": "MCPApprovalRequest",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](mcp_approval_response)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A response to an MCP approval request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "mcp_approval_response",
  "schema_ref": "MCPApprovalResponse",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](mcp_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An invocation of a tool on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "mcp_call",
  "schema_ref": "MCPToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](custom_tool_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a custom tool call from your code, being sent back to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "custom_tool_call_output",
  "schema_ref": "CustomToolCallOutput",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](custom_tool_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A call to a custom tool created by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "custom_tool_call",
  "schema_ref": "CustomToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](compaction_trigger)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Compacts the current context. Must be the final input item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "compaction_trigger",
  "schema_ref": "CompactionTriggerItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](item_reference)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An internal identifier for an item to reference.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "ItemReferenceParam",
  "schema_ref": "ItemReferenceParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "program",
  "schema_ref": "ProgramItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "input[](program_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "program_output",
  "schema_ref": "ProgramOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "previous_response_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "notes": "Mutually exclusive with `conversation` (live p1: 400 mutually_exclusive_parameters). Unknown id -> 400 previous_response_not_found (live p6). Prior turns are re-billed as input tokens.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tools",
  "location": "body",
  "type": "array<object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of tools the model may call while generating a response. You can specify which tool to use by setting the `tool_choice` parameter.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "notes": "Tool definitions are documented by the tools fragments (generated/fragments/tools/**); only the shape is referenced here.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tools[]",
  "location": "body",
  "type": "object<function> | object<file_search> | object<computer> | object<computer_use_preview> | WebSearchTool | object<mcp> | object<code_interpreter> | object<programmatic_tool_calling> | object<image_generation> | object<local_shell> | object<shell> | object<custom> | object<namespace> | object<tool_search> | WebSearchPreviewTool | object<apply_patch>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool that can be used to generate a response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "schema_ref": "Tool",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "text",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more: - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text) - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "text.format",
  "location": "body",
  "type": "object<text> | object<json_schema> | object<json_object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object specifying the format that the model must output. Configuring `{ \"type\": \"json_schema\" }` enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs). The default format is `{ \"type\": \"text\" }` with no additional options. **Not recommended for gpt-4o and newer models:** Setting to `{ \"type\": \"json_object\" }` enables the older JSON mode, which ensures the message the model generates is valid JSON. Using `json_schema` is preferred for models that support it.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "schema_ref": "TextResponseFormatConfiguration",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "text.verbosity",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "Constrains the verbosity of the model's response. Lower values will result in more concise responses, while higher values will result in more verbose responses. Currently supported values are `low`, `medium`, and `high`. The default is `medium`.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4*",
   "gpt-5.2*",
   "gpt-5.1*",
   "gpt-5*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "schema_ref": "Verbosity",
  "notes": "GPT-5+ only. Live p11: gpt-4.1-nano + verbosity \"low\" -> 400 unsupported_value (\"Supported values are: 'medium'\").",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "reasoning",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "**gpt-5 and o-series models only** Configuration options for [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "reasoning.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Controls the reasoning execution mode for the request. When returned on a response, this is the effective execution mode.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "schema_ref": "ReasoningModeEnum",
  "notes": "Enum from ReasoningModeEnum: standard | pro (GPT-5.6 models). Live: response echoes mode=\"standard\" on gpt-5.4-nano.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "reasoning.effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "minimal",
   "low",
   "medium",
   "high",
   "xhigh",
   "max"
  ],
  "description": "Constrains effort on reasoning for reasoning models. Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for model-specific support.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "schema_ref": "ReasoningEffort",
  "notes": "Live: gpt-5.4-nano echoes effort=\"none\" when omitted (response.reasoning.effort). gpt-6-astra rejects \"none\" with HTTP 400 (guide). gpt-4.1-nano returns 400 unsupported_parameter (live p5).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "reasoning.summary",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "concise",
   "detailed"
  ],
  "description": "A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`. `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "notes": "Live: summary=\"auto\" is echoed back as \"detailed\" on gpt-5.4-nano; summary items only appear when the model actually reasons (f3: 118 reasoning tokens -> 1 summary_text).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "reasoning.context",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "current_turn",
   "all_turns"
  ],
  "description": "Controls which reasoning items are rendered back to the model on later turns. If omitted or set to `auto`, the model determines the context mode. The `gpt-5.6` model family defaults to `all_turns`; earlier models default to `current_turn`. When returned on a response, this is the effective reasoning context mode used for the response.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "notes": "GPT-5.6 family defaults to all_turns; earlier models default to current_turn. Live: gpt-5.4-nano echoes context=\"current_turn\".",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "reasoning.generate_summary",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "concise",
   "detailed"
  ],
  "description": "**Deprecated:** use `summary` instead. A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-*",
   "gpt-5.5",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.2",
   "gpt-5.1",
   "gpt-5",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5*-codex*",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "truncation",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "disabled"
  ],
  "description": "The truncation strategy to use for the model response. - `auto`: If the input to this Response exceeds the model's context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation. - `disabled` (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "schema_ref": "TruncationEnum",
  "notes": "Marked deprecated in the OpenAPI spec (CreateResponse) but still accepted and echoed (live p7: truncation=\"auto\"). Use context_management (compaction) instead.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A system (or developer) message inserted into the model's context. When used along with `previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "personality",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A model-owned style preset to apply to this request. Omit this parameter to use the model's default style. Supported values may expand over time. Values must be at most 64 characters.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "schema_ref": "PersonalityEnum",
  "notes": "Documented only in the TokenCountsBody schema (PersonalityEnum: friendly | pragmatic). Live p10 (2026-09-18): accepted by POST /v1/responses on gpt-5.4-nano (HTTP 200) and echoed as `personality: null` in the Response object -> LIVE_DISCOVERED for create.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "conversation",
  "location": "body",
  "type": "string | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The conversation that this response belongs to. Items from this conversation are prepended to `input_items` for this response request. Input items and output items from this response are automatically added to this conversation after this response completes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "notes": "Mutually exclusive with previous_response_id. Accepts a string id or {\"id\": ...}; response echoes {\"id\": \"conv_...\"}. Items of the response are appended to the conversation (live k6).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "conversation(object)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The conversation that this response belongs to.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "ConversationParam-2",
  "schema_ref": "ConversationParam-2",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tool_choice",
  "location": "body",
  "type": "string | object<allowed_tools> | ToolChoiceTypes | object<function> | object<mcp> | object<custom> | object<programmatic_tool_calling> | object<apply_patch> | object<shell>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Controls which tool the model should use, if any.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "notes": "Detailed per-tool tool_choice objects are documented by the tools fragments.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tool_choice(allowed_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Constrains the tools available to the model to a pre-defined set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "allowed_tools",
  "schema_ref": "ToolChoiceAllowed",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tool_choice(hosted_tool)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "ToolChoiceTypes",
  "schema_ref": "ToolChoiceTypes",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tool_choice(function)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Use this option to force the model to call a specific function.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "function",
  "schema_ref": "ToolChoiceFunction",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tool_choice(mcp)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Use this option to force the model to call a specific tool on a remote MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "mcp",
  "schema_ref": "ToolChoiceMCP",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tool_choice(custom)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Use this option to force the model to call a specific custom tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "custom",
  "schema_ref": "ToolChoiceCustom",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tool_choice(programmatic_tool_calling)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "programmatic_tool_calling",
  "schema_ref": "SpecificProgrammaticToolCallingParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tool_choice(apply_patch)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Forces the model to call the apply_patch tool when executing a tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "apply_patch",
  "schema_ref": "SpecificApplyPatchParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "tool_choice(shell)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Forces the model to call the shell tool when a tool call is required.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "variant": "shell",
  "schema_ref": "SpecificFunctionShellParam",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/input_tokens",
  "parameter": "parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to allow the model to run tool calls in parallel.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/subresources/input_tokens/methods/count",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "model",
  "location": "body",
  "type": "string | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](https://developers.openai.com/api/docs/models) to browse and compare available models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "nullable": true,
  "schema_ref": "ModelIdsCompaction",
  "notes": "Live models used: gpt-5.4-nano (responses), gpt-4.1-nano (chat/vision), gpt-3.5-turbo-instruct (completions).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input",
  "location": "body",
  "type": "string | array<object<message> | object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image, or file inputs to the model, used to generate a response",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "nullable": true,
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[]",
  "location": "body",
  "type": "array<object<message> | object<message> | object<file_search_call> | object<computer_call> | object<computer_call_output> | object<web_search_call> | object<function_call> | object<function_call_output> | object<tool_search_call> | object<tool_search_output> | object<additional_tools> | object<configuration_update> | object<reasoning> | object<compaction> | object<image_generation_call> | object<code_interpreter_call> | object<local_shell_call> | object<local_shell_call_output> | object<shell_call> | object<shell_call_output> | object<apply_patch_call> | object<apply_patch_call_output> | object<mcp_list_tools> | object<mcp_approval_request> | object<mcp_approval_response> | object<mcp_call> | object<custom_tool_call_output> | object<custom_tool_call> | object<compaction_trigger> | ItemReferenceParam | object<program> | object<program_output>> | object<program_output>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of one or many input items to the model, containing different content types.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](message)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A message input to the model with a role indicating instruction following hierarchy. Instructions given with the `developer` or `system` role take precedence over instructions given with the `user` role. Messages with the `assistant` role are presumed to have been generated by the model in previous interactions.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "message",
  "schema_ref": "EasyInputMessage",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](file_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a file search tool call. See the [file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "file_search_call",
  "schema_ref": "FileSearchToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](computer_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to a computer use tool. See the [computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "computer_call",
  "schema_ref": "ComputerToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](computer_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a computer tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "computer_call_output",
  "schema_ref": "ComputerCallOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](web_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of a web search tool call. See the [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "web_search_call",
  "schema_ref": "WebSearchToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](function_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a function. See the [function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "function_call",
  "schema_ref": "FunctionToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](function_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "function_call_output",
  "schema_ref": "FunctionCallOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](tool_search_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "tool_search_call",
  "schema_ref": "ToolSearchCallItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](tool_search_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "tool_search_output",
  "schema_ref": "ToolSearchOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](additional_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "additional_tools",
  "schema_ref": "AdditionalToolsItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](configuration_update)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An update to the conversation's response configuration. The configuration remains in effect for subsequent responses until it is replaced by another configuration update.",
  "compatible_models": [
   "gpt-6-astra"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "configuration_update",
  "schema_ref": "ResponseConfigurationUpdateItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](reasoning)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your `input` to the Responses API for subsequent turns of a conversation if you are manually [managing context](https://developers.openai.com/api/docs/guides/conversation-state).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "reasoning",
  "schema_ref": "ReasoningItem",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](compaction)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact).",
  "compatible_models": [
   "* (responses models supporting compaction)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "compaction",
  "schema_ref": "CompactionSummaryItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](image_generation_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An image generation request made by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "image_generation_call",
  "schema_ref": "ImageGenToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](code_interpreter_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run code.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "code_interpreter_call",
  "schema_ref": "CodeInterpreterToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](local_shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call to run a command on the local shell.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "local_shell_call",
  "schema_ref": "LocalShellToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](local_shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a local shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "local_shell_call_output",
  "schema_ref": "LocalShellToolCallOutput",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](shell_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool representing a request to execute one or more shell commands.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "shell_call",
  "schema_ref": "FunctionShellCallItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](shell_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output items emitted by a shell tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "shell_call_output",
  "schema_ref": "FunctionShellCallOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](apply_patch_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A tool call representing a request to create, delete, or update files using diff patches.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "apply_patch_call",
  "schema_ref": "ApplyPatchToolCallItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](apply_patch_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The streamed output emitted by an apply patch tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "apply_patch_call_output",
  "schema_ref": "ApplyPatchToolCallOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](mcp_list_tools)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools available on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "mcp_list_tools",
  "schema_ref": "MCPListTools",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](mcp_approval_request)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A request for human approval of a tool invocation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "mcp_approval_request",
  "schema_ref": "MCPApprovalRequest",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](mcp_approval_response)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A response to an MCP approval request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "mcp_approval_response",
  "schema_ref": "MCPApprovalResponse",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](mcp_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An invocation of a tool on an MCP server.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "mcp_call",
  "schema_ref": "MCPToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](custom_tool_call_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of a custom tool call from your code, being sent back to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "custom_tool_call_output",
  "schema_ref": "CustomToolCallOutput",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](custom_tool_call)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A call to a custom tool created by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "custom_tool_call",
  "schema_ref": "CustomToolCall",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](compaction_trigger)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Compacts the current context. Must be the final input item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "compaction_trigger",
  "schema_ref": "CompactionTriggerItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](item_reference)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An internal identifier for an item to reference.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "ItemReferenceParam",
  "schema_ref": "ItemReferenceParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](program)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "program",
  "schema_ref": "ProgramItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[](program_output)",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "variant": "program_output",
  "schema_ref": "ProgramOutputItemParam",
  "notes": "Same item union as POST /v1/responses `input` (see openai-responses.json for the nested paths).",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "previous_response_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about [conversation state](https://developers.openai.com/api/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "nullable": true,
  "notes": "Mutually exclusive with `conversation` (live p1: 400 mutually_exclusive_parameters). Unknown id -> 400 previous_response_not_found (live p6). Prior turns are re-billed as input tokens.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A system (or developer) message inserted into the model's context. When used along with `previous_response_id`, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "prompt_cache_key",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A key to use when reading from or writing to the prompt cache.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "nullable": true,
  "notes": "Live n: same key + same ~1.5k-token prefix twice on gpt-5.4-nano -> cached_tokens=0 both times (no hit within 1.5 s); chat gpt-4.1-nano -> 1408 cached of 1556 on 2nd call.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "prompt_cache_retention",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_memory",
   "24h"
  ],
  "description": "How long to retain a prompt cache entry created by this request.",
  "compatible_models": [
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.4",
   "gpt-5.2",
   "gpt-5.1-codex-max",
   "gpt-5.1",
   "gpt-5.1-codex",
   "gpt-5.1-codex-mini",
   "gpt-5.1-chat-latest",
   "gpt-5",
   "gpt-5-codex",
   "gpt-4.1",
   "(in_memory: all cache-capable models)"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "nullable": true,
  "notes": "Deprecated in favour of prompt_cache_options.ttl (GPT-5.6+). Live: response echoes \"24h\" by default and \"in_memory\" when requested.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "prompt_cache_options",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Options for prompt caching. Supported for `gpt-5.6` and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with `prompt_cache_breakpoint`. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set `mode` to `explicit` to disable the implicit breakpoint. The `ttl` defaults to `30m`, which is currently the only supported value. See the [prompt caching guide](https://developers.openai.com/api/docs/guides/prompt-caching) for current details.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "nullable": true,
  "notes": "GPT-5.6+ only. Live p12: gpt-5.4-nano -> 400 invalid_parameter \"prompt_cache_options is not supported on this model\".",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "prompt_cache_options.ttl",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "30m"
  ],
  "description": "The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. Defaults to `30m`, which is currently the only supported value. The backend may retain cache entries for longer.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "schema_ref": "PromptCacheTTLEnum",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "prompt_cache_options.mode",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "implicit",
   "explicit"
  ],
  "description": "Controls whether OpenAI automatically creates an implicit cache breakpoint. Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint and writes up to the latest three explicit breakpoints in the request. With `explicit`, OpenAI does not create an implicit breakpoint and writes up to the latest four explicit breakpoints. If there are no explicit breakpoints, the request does not use prompt caching.",
  "compatible_models": [
   "gpt-6-astra",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-5.6-luna"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "schema_ref": "PromptCacheModeEnum",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "service_tier",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default",
   "fast",
   "flex",
   "priority"
  ],
  "description": "Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. For models with a dedicated Fast tier, either value resolves to `service_tier=fast`; for other models, either value resolves to `service_tier=priority`. - When not set, the ",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/responses/methods/compact",
  "nullable": true,
  "notes": "Requested \"auto\" is echoed as the effective tier (\"default\" live). fast/priority/flex/scale availability depends on model & account.",
  "_fragment": "generated/fragments/parameters/openai-responses.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/safety/alerts/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": 38,
  "enum": null,
  "description": "Project safety alert id (maxLength 38; webhook pattern ^alert_[0-9a-f]{32}$; guide examples use 'salert_123').",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/safety-checks/misalignment-monitoring",
  "notes": "Live: unknown id -> 404 code safety_alert_not_found.",
  "_fragment": "generated/fragments/parameters/openai-safety.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/safety/cases/{id}",
  "parameter": "id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": 128,
  "enum": null,
  "description": "Safety case id (maxLength 128; webhook example 'C-abc123').",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml",
  "notes": "Live: 403 missing scope api.safety.read.",
  "_fragment": "generated/fragments/parameters/openai-safety.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/content_provenance_checks",
  "parameter": "file",
  "location": "body",
  "type": "file (multipart; set the part's media type)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image (image/png, image/jpeg, image/webp) or audio (MP3, Opus as audio/ogg, AAC, FLAC, WAV, PCM; <= 60 s decoded). <= 50 MiB, one file per request. Do not add a separate `type` field.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/content-provenance",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-safety.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "safety_identifier",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 64,
  "enum": null,
  "description": "Stable, privacy-preserving end-user id (hash of username/email), max 64 chars. Lets OpenAI block an abusive end user instead of the whole org; blocked ids get an 'identifier blocked' error. Replaces the legacy `user` field together with prompt_cache_key.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/safety-best-practices",
  "notes": "Owned by the Responses agent for the full endpoint; recorded here for the safety cross-reference.",
  "_fragment": "generated/fragments/parameters/openai-safety.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "safety_identifier",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 64,
  "enum": null,
  "description": "Same semantics as on /v1/responses (max 64 chars).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/safety-best-practices",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-safety.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "OpenAI-Safety-Identifier",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Header carrying the safety identifier for Realtime sessions (also on direct WebSocket/WebRTC connection requests from a trusted backend). Identifiers do not carry over between APIs or sessions.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/safety-checks",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-safety.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "moderation",
  "location": "body",
  "type": "{model: string}",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Top-level object requesting moderation scores for the input and the generated output in the same response (omni-moderation-latest). Scores arrive after the full output when streaming; may contain an error object if moderation failed.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/moderation",
  "notes": "Also accepted by POST /v1/chat/completions (changelog). Full endpoint owned by other agents.",
  "_fragment": "generated/fragments/parameters/openai-safety.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=function].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": "The type of the function tool. Always `function`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=function].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to call.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=function].async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=function].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of the function. Used by the model to determine whether or not to call the function.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=function].parameters",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON schema object describing the parameters of the function.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=function].output_schema",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON schema object describing the JSON value encoded in string outputs for this function.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=function].strict",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether strict parameter validation is enforced for this function tool.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=function].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether this function is deferred and loaded via tool search.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=function].allowed_callers",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tool invocation context(s).",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "custom",
  "minimum": null,
  "maximum": null,
  "enum": [
   "custom"
  ],
  "description": "The type of the custom tool. Always `custom`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the custom tool, used to identify it in tool calls.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the tool response can be returned asynchronously versus immediately returned on next response creation.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional description of the custom tool, used to provide more context.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].format",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input format for the custom tool. Default is unconstrained text.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "text",
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "Unconstrained text format. Always `text`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].format.syntax",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "lark",
   "regex"
  ],
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].format.definition",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The grammar definition.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether this tool should be deferred and discovered via tool search.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=custom].allowed_callers",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tool invocation context(s).",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#custom-tools",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "namespace",
  "minimum": null,
  "maximum": null,
  "enum": [
   "namespace"
  ],
  "description": "The type of the tool. Always `namespace`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The namespace name used in tool calls (for example, `crm`).",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "constraints": {
   "minLength": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of the namespace shown to the model.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools",
  "location": "body",
  "type": "array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The function/custom tools available inside this namespace.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "constraints": {
   "minLength": 1,
   "maxLength": 128,
   "pattern": "^[a-zA-Z0-9_-]+$"
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].parameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].strict",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "function",
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].async",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the tool response can be returned asynchronously versus immediately returned on next response creation.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].output_schema",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether this function should be deferred and discovered via tool search.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].allowed_callers",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tool invocation context(s).",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].format",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input format for the custom tool. Default is unconstrained text.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "text",
  "minimum": null,
  "maximum": null,
  "enum": [
   {
    "$comment": "depth-limited"
   }
  ],
  "description": "Unconstrained text format. Always `text`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].format.syntax",
  "location": "body",
  "type": {
   "$comment": "depth-limited"
  },
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": {
   "$comment": "depth-limited"
  },
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=namespace].tools[].format.definition",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The grammar definition.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-audio-mini",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling#namespaces",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=tool_search].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "tool_search",
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search"
  ],
  "description": "The type of the tool. Always `tool_search`.",
  "compatible_models": [
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-tool-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=tool_search].execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server",
   "client"
  ],
  "description": "",
  "compatible_models": [
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-tool-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=tool_search].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description shown to the model for a client-executed tool search tool.",
  "compatible_models": [
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-tool-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=tool_search].parameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-tool-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=programmatic_tool_calling].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "programmatic_tool_calling",
  "minimum": null,
  "maximum": null,
  "enum": [
   "programmatic_tool_calling"
  ],
  "description": "The type of the tool. Always `programmatic_tool_calling`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-programmatic-tool-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "web_search",
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search",
   "web_search_2025_08_26"
  ],
  "description": "The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].external_web_access",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].filters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filters for the search.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].filters.allowed_domains",
  "location": "body",
  "type": "array",
  "required": false,
  "default": [],
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Allowed domains for the search. If not provided, all domains are allowed.\nSubdomains of the provided domains are allowed as well.\n\nExample: `[\"pubmed.ncbi.nlm.nih.gov\"]`",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].user_location",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The approximate location of the user.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].user_location.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "approximate",
  "minimum": null,
  "maximum": null,
  "enum": [
   "approximate"
  ],
  "description": "The type of location approximation. Always `approximate`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].user_location.country",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].user_location.region",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free text input for the region of the user, e.g. `California`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].user_location.city",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free text input for the city of the user, e.g. `San Francisco`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].user_location.timezone",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].search_context_size",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search_preview].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "web_search_preview",
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search_preview",
   "web_search_preview_2025_03_11"
  ],
  "description": "The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search_preview].user_location",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search_preview].user_location.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "approximate",
  "minimum": null,
  "maximum": null,
  "enum": [
   "approximate"
  ],
  "description": "The type of location approximation. Always `approximate`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search_preview].user_location.country",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search_preview].user_location.region",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free text input for the region of the user, e.g. `California`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search_preview].user_location.city",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free text input for the city of the user, e.g. `San Francisco`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search_preview].user_location.timezone",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search_preview].search_context_size",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high"
  ],
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search_preview].search_content_types",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "file_search",
  "minimum": null,
  "maximum": null,
  "enum": [
   "file_search"
  ],
  "description": "The type of the file search tool. Always `file_search`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].vector_store_ids",
  "location": "body",
  "type": "array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The IDs of the vector stores to search.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].max_num_results",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of results to return. This number should be between 1 and 50 inclusive.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].ranking_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].ranking_options.ranker",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "default-2024-11-15"
  ],
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].ranking_options.score_threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].ranking_options.hybrid_search",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].ranking_options.hybrid_search.embedding_weight",
  "location": "body",
  "type": "number",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The weight of the embedding in the reciprocal ranking fusion.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].ranking_options.hybrid_search.text_weight",
  "location": "body",
  "type": "number",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The weight of the text in the reciprocal ranking fusion.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].filters",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].filters.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "eq",
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "gt",
   "gte",
   "lt",
   "lte",
   "in",
   "nin"
  ],
  "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n- `in`: in\n- `nin`: not in",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].filters.key",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The key to compare against the value.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].filters.value",
  "location": "body",
  "type": "oneOf",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The value to compare against the attribute key; supports string, number, or boolean types.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=file_search].filters.filters",
  "location": "body",
  "type": "array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-mini",
   "o3-pro",
   "o4-mini"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-file-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "code_interpreter"
  ],
  "description": "The type of the code interpreter tool. Always `code_interpreter`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].container",
  "location": "body",
  "type": "oneOf",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The code interpreter container. Can be a container ID or an object that\nspecifies uploaded file IDs to make available to your code, along with an\noptional `memory_limit` setting.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].container.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "description": "Always `auto`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].container.file_ids",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional list of uploaded files to make available to your code.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "constraints": {
   "maxItems": 50
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].container.memory_limit",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1g",
   "4g",
   "16g",
   "64g"
  ],
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].container.network_policy",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network access policy for the container.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].container.network_policy.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "disabled",
  "minimum": null,
  "maximum": null,
  "enum": [
   "disabled"
  ],
  "description": "Disable outbound network access. Always `disabled`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].container.network_policy.allowed_domains",
  "location": "body",
  "type": "array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of allowed domains when type is `allowlist`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].container.network_policy.domain_secrets",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional domain-scoped secrets for allowlisted domains.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=code_interpreter].allowed_callers",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tool invocation context(s).",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1-mini",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-code-interpreter",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=computer].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer"
  ],
  "description": "The type of the computer tool. Always `computer`.",
  "compatible_models": [
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-computer-use",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=computer_use_preview].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "computer_use_preview",
  "minimum": null,
  "maximum": null,
  "enum": [
   "computer_use_preview"
  ],
  "description": "The type of the computer use tool. Always `computer_use_preview`.",
  "compatible_models": [
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-computer-use",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=computer_use_preview].environment",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "windows",
   "mac",
   "linux",
   "ubuntu",
   "browser"
  ],
  "description": "",
  "compatible_models": [
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-computer-use",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=computer_use_preview].display_width",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The width of the computer display.",
  "compatible_models": [
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-computer-use",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=computer_use_preview].display_height",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The height of the computer display.",
  "compatible_models": [
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "PREVIEW"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-computer-use",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image_generation"
  ],
  "description": "The type of the image generation tool. Always `image_generation`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].model",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].quality",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "max",
   "auto"
  ],
  "description": "The quality of the generated image. The GPT image models support `low`,\n`medium`, and `high`. `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`,\nincluding their `2026-09-08` snapshots, also support `xhigh` and `max`.\nDefault: `auto`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].size",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].output_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "png",
  "minimum": null,
  "maximum": null,
  "enum": [
   "png",
   "webp",
   "jpeg"
  ],
  "description": "The output format of the generated image. One of `png`, `webp`, or\n`jpeg`. Default: `png`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].output_compression",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 100,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "Compression level for the output image. Default: 100.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].moderation",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "low"
  ],
  "description": "Moderation level for the generated image. Default: `auto`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].background",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "transparent",
   "opaque",
   "auto"
  ],
  "description": "Set the background of the generated image. One of `transparent`, `opaque`,\nor `auto`. `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including\ntheir `2026-09-08` snapshots, support `opaque` and `transparent`\nbackgrounds. Transparent backgrounds are available for supported GPT Image\nmodels. For `gpt-image-2` and `gpt-image-2-2026-04-21`, this support is in\npreview. When using `transparent`, set the output format to `png` or `webp`.\nDefault: `auto`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].input_fidelity",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "high",
   "low"
  ],
  "description": "Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].input_image_mask",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional mask for inpainting. Contains `image_url`\n(string, optional) and `file_id` (string, optional).",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].input_image_mask.image_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Base64-encoded mask image.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].input_image_mask.file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File ID for the mask image.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].partial_images",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 0,
  "minimum": 0,
  "maximum": 3,
  "enum": null,
  "description": "Number of partial images to generate in streaming mode, from 0 (default value) to 3.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=image_generation].action",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "generate",
   "edit",
   "auto"
  ],
  "description": "",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "o3",
   "o3-mini",
   "o3-pro"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-image-generation",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp"
  ],
  "description": "The type of the MCP tool. Always `mcp`.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A label for this MCP server, used to identify it in tool calls.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].server_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "constraints": {
   "format": "uri"
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].connector_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "connector_dropbox",
   "connector_gmail",
   "connector_googlecalendar",
   "connector_googledrive",
   "connector_microsoftteams",
   "connector_outlookcalendar",
   "connector_outlookemail",
   "connector_sharepoint"
  ],
  "description": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).\n\nThis field is deprecated for models released after September 1, 2026.\nUse `server_url` to connect to a remote MCP server, or `tunnel_id` to\nconnect through a Secure MCP Tunnel.\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].tunnel_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "constraints": {
   "pattern": "^tunnel_[a-z0-9]{32}$"
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].authorization",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].server_description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional description of the MCP server, used to provide more context.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].headers",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].allowed_tools",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of allowed tool names or a filter object.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].allowed_tools.tool_names",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of allowed tool names.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].allowed_tools.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].allowed_callers",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tool invocation context(s).",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].require_approval",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": "always",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specify which of the MCP server's tools require approval.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].require_approval.always",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].require_approval.always.tool_names",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of allowed tool names.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].require_approval.always.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].require_approval.never",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A filter object to specify which tools are allowed.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].require_approval.never.tool_names",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of allowed tool names.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].require_approval.never.read_only",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=mcp].defer_loading",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether this MCP tool is deferred and discovered via tool search.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4.1-nano",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o1",
   "o1-mini",
   "o1-pro",
   "o3",
   "o3-deep-research",
   "o3-mini",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-connectors-mcp",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "shell",
  "minimum": null,
  "maximum": null,
  "enum": [
   "shell"
  ],
  "description": "The type of the shell tool. Always `shell`.",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "container_auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "container_auto"
  ],
  "description": "Automatically creates a container for this request",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.file_ids",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional list of uploaded files to make available to your code.",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "constraints": {
   "maxItems": 50
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.memory_limit",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1g",
   "4g",
   "16g",
   "64g"
  ],
  "description": "",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.network_policy",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network access policy for the container.",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.network_policy.type",
  "location": "body",
  "type": {
   "$comment": "depth-limited"
  },
  "required": true,
  "default": {
   "$comment": "depth-limited"
  },
  "minimum": null,
  "maximum": null,
  "enum": {
   "$comment": "depth-limited"
  },
  "description": "{'$comment': 'depth-limited'}",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.network_policy.allowed_domains",
  "location": "body",
  "type": {
   "$comment": "depth-limited"
  },
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{'$comment': 'depth-limited'}",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "constraints": {
   "minItems": {
    "$comment": "depth-limited"
   }
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.network_policy.domain_secrets",
  "location": "body",
  "type": {
   "$comment": "depth-limited"
  },
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{'$comment': 'depth-limited'}",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "constraints": {
   "minItems": {
    "$comment": "depth-limited"
   }
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.skills",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional list of skills referenced by id or inline data.",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "constraints": {
   "maxItems": 200
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.skills[].type",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.skills[].skill_id",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.skills[].version",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.skills[].name",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.skills[].description",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.skills[].source",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].environment.container_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the referenced container.",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=shell].allowed_callers",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tool invocation context(s).",
  "compatible_models": [
   "gpt-5.2",
   "gpt-5.2-codex",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-shell",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=local_shell].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "local_shell",
  "minimum": null,
  "maximum": null,
  "enum": [
   "local_shell"
  ],
  "description": "The type of the local shell tool. Always `local_shell`.",
  "compatible_models": [
   "codex-mini-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-local-shell",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=apply_patch].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "apply_patch",
  "minimum": null,
  "maximum": null,
  "enum": [
   "apply_patch"
  ],
  "description": "The type of the tool. Always `apply_patch`.",
  "compatible_models": [
   "gpt-5.1",
   "gpt-5.2",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-apply-patch",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=apply_patch].allowed_callers",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The tool invocation context(s).",
  "compatible_models": [
   "gpt-5.1",
   "gpt-5.2",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-apply-patch",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "allowed_tools"
  ],
  "description": "Allowed tool configuration type. Always `allowed_tools`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "required"
  ],
  "description": "Constrains the tools available to the model to a pre-defined set.\n\n`auto` allows the model to pick from among the allowed tools and generate a\nmessage.\n\n`required` requires the model to call one or more of the allowed tools.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice.tools",
  "location": "body",
  "type": "array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tool definitions that the model should be allowed to call.\n\nFor the Responses API, the list of tool definitions might look like:\n```json\n[\n  { \"type\": \"function\", \"name\": \"get_weather\" },\n  { \"type\": \"mcp\", \"server_label\": \"deepwiki\" },\n  { \"type\": \"image_generation\" }\n]\n```",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice.server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server to use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "parallel_tool_calls",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling) during tool use.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "include",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Extra output fields; tool-related values: file_search_call.results, web_search_call.results, web_search_call.action.sources, code_interpreter_call.outputs, computer_call_output.output.image_url.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "max_tool_calls",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of built-in tool calls (web search, file search, MCP…) in a response; used notably with deep research models.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].return_token_budget",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "default",
   "unlimited"
  ],
  "description": "Token budget for returned web search content (GPT-5+ reasoning web search). Documented in the guide, echoed live (default), absent from OpenAPI spec.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].filters.blocked_domains",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Up to 100 blocked domains (guide); absent from OpenAPI spec.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[type=web_search].search_content_types",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "image"
  ],
  "description": "Image search: include 'image' (and 'text'). Echoed live as ['text']; present in spec only on web_search_preview.",
  "compatible_models": [
   "chat-latest",
   "gpt-4.1",
   "gpt-4.1-mini",
   "gpt-4o",
   "gpt-4o-mini",
   "gpt-4o-mini-audio-preview",
   "gpt-5",
   "gpt-5-chat-latest",
   "gpt-5-codex",
   "gpt-5-mini",
   "gpt-5-nano",
   "gpt-5-pro",
   "gpt-5.1",
   "gpt-5.1-chat-latest",
   "gpt-5.1-codex",
   "gpt-5.1-codex-max",
   "gpt-5.1-codex-mini",
   "gpt-5.2",
   "gpt-5.2-chat-latest",
   "gpt-5.2-codex",
   "gpt-5.2-pro",
   "gpt-5.3-chat-latest",
   "gpt-5.3-codex",
   "gpt-5.4",
   "gpt-5.4-mini",
   "gpt-5.4-nano",
   "gpt-5.4-pro",
   "gpt-5.5",
   "gpt-5.5-pro",
   "gpt-5.6-cyber",
   "gpt-5.6-luna",
   "gpt-5.6-sol",
   "gpt-5.6-terra",
   "gpt-6-astra",
   "gpt-daybreak-blue-latest",
   "gpt-daybreak-red-latest",
   "gpt-oss-120b",
   "gpt-oss-20b",
   "o3",
   "o3-deep-research",
   "o3-pro",
   "o4-mini",
   "o4-mini-deep-research"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/tools-web-search",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[]",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": "The type of the tool. Currently, only `function` is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function.description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of what the function does, used by the model to choose when and how to call the function.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function.parameters",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://developers.openai.com/api/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.\n\nOmitting `parameters` defines a function with an empty parameter list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function.strict",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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`. Learn more about Structured Outputs in the [function calling guide](https://developers.openai.com/api/docs/guides/function-calling).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].custom",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Properties of the custom tool.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].custom.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the custom tool, used to identify it in tool calls.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].custom.description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional description of the custom tool, used to provide more context.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].custom.format",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input format for the custom tool. Default is unconstrained text.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].custom.format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": "Unconstrained text format. Always `text`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].custom.format.grammar",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Your chosen grammar.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].custom.format.grammar.definition",
  "location": "body",
  "type": {
   "$comment": "depth-limited"
  },
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{'$comment': 'depth-limited'}",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].custom.format.grammar.syntax",
  "location": "body",
  "type": {
   "$comment": "depth-limited"
  },
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": {
   "$comment": "depth-limited"
  },
  "description": "{'$comment': 'depth-limited'}",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tool and instead generates a message.\n`auto` means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools.\nSpecifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n\n`none` is the default when no tools are present. `auto` is the default if tools are present.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "allowed_tools"
  ],
  "description": "Allowed tool configuration type. Always `allowed_tools`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.allowed_tools",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Constrains the tools available to the model to a pre-defined set.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.allowed_tools.mode",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "required"
  ],
  "description": "Constrains the tools available to the model to a pre-defined set.\n\n`auto` allows the model to pick from among the allowed tools and generate a\nmessage.\n\n`required` requires the model to call one or more of the allowed tools.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.allowed_tools.tools",
  "location": "body",
  "type": "array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tool definitions that the model should be allowed to call.\n\nFor the Chat Completions API, the list of tool definitions might look like:\n```json\n[\n  { \"type\": \"function\", \"function\": { \"name\": \"get_weather\" } },\n  { \"type\": \"function\", \"function\": { \"name\": \"get_time\" } }\n]\n```",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.function",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.function.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function to call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.custom",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.custom.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the custom tool to call.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/function-calling",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the container to create.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "file_ids",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "IDs of files to copy to the container.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "expires_after",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Container expiration time in seconds relative to the 'anchor' time.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "expires_after.anchor",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "last_active_at"
  ],
  "description": "Time anchor for the expiration time. Currently only 'last_active_at' is supported.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "expires_after.minutes",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional list of skills referenced by id or inline data.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "skill_reference",
  "minimum": null,
  "maximum": null,
  "enum": [
   "skill_reference"
  ],
  "description": "References a skill created with the /v1/skills endpoint.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills[].skill_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the referenced skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "constraints": {
   "minLength": 1,
   "maxLength": 64
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills[].version",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional skill version. Use a positive integer or 'latest'. Omit for default.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The description of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills[].source",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline skill payload",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "base64",
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "description": "The type of the inline skill source. Must be `base64`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "application/zip",
  "minimum": null,
  "maximum": null,
  "enum": [
   "application/zip"
  ],
  "description": "The media type of the inline skill payload. Must be `application/zip`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "skills[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Base64-encoded skill zip bundle.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "constraints": {
   "minLength": 1,
   "maxLength": 70254592
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "memory_limit",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1g",
   "4g",
   "16g",
   "64g"
  ],
  "description": "Optional memory limit for the container. Defaults to \"1g\".",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "network_policy",
  "location": "body",
  "type": "oneOf",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Network access policy for the container.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "network_policy.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "disabled",
  "minimum": null,
  "maximum": null,
  "enum": [
   "disabled"
  ],
  "description": "Disable outbound network access. Always `disabled`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "network_policy.allowed_domains",
  "location": "body",
  "type": "array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of allowed domains when type is `allowlist`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "network_policy.domain_secrets",
  "location": "body",
  "type": "array",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional domain-scoped secrets for allowlisted domains.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "constraints": {
   "minItems": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "network_policy.domain_secrets[].domain",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The domain associated with the secret.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "constraints": {
   "minLength": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "network_policy.domain_secrets[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the secret to inject for the domain.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "constraints": {
   "minLength": 1
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers",
  "parameter": "network_policy.domain_secrets[].value",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The secret value to inject for the domain.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/methods/create",
  "constraints": {
   "minLength": 1,
   "maxLength": 10485760
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers/{container_id}/files",
  "parameter": "file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the file to create.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/subresources/files/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers/{container_id}/files",
  "parameter": "file",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The File object (not file name) to be uploaded.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers/subresources/files/methods/create",
  "constraints": {
   "format": "binary"
  },
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/skills",
  "parameter": "files",
  "location": "body",
  "type": "oneOf",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/skills/{skill_id}/versions",
  "parameter": "files",
  "location": "body",
  "type": "oneOf",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills/subresources/versions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/skills/{skill_id}/versions",
  "parameter": "default",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to set this version as the default.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills/subresources/versions/methods/create",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/skills/{skill_id}",
  "parameter": "default_version",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The skill version number to set as default.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills/methods/update",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers",
  "parameter": "name",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter results by container name.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers/{container_id}",
  "parameter": "container_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/containers/{container_id}",
  "parameter": "container_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the container to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/containers/{container_id}/files",
  "parameter": "container_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers/{container_id}/files",
  "parameter": "container_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers/{container_id}/files",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers/{container_id}/files",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers/{container_id}/files",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers/{container_id}/files/{file_id}",
  "parameter": "container_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers/{container_id}/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/containers/{container_id}/files/{file_id}",
  "parameter": "container_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/containers/{container_id}/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers/{container_id}/files/{file_id}/content",
  "parameter": "container_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/containers/{container_id}/files/{file_id}/content",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/containers",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "Number of items to retrieve",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sort order of results by timestamp. Use `asc` for ascending order or `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Identifier for the last item from the previous pagination request",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/skills/{skill_id}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the skill to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the skill to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/skills/{skill_id}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}/content",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the skill to download.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/skills/{skill_id}/versions",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the skill to version.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}/versions",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}/versions",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 100,
  "enum": null,
  "description": "Number of versions to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}/versions",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Sort order of results by version number.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}/versions",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The skill version ID to start after.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}",
  "parameter": "version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The version number to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/skills/{skill_id}/versions/{version}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/skills/{skill_id}/versions/{version}",
  "parameter": "version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The skill version number.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}/content",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The identifier of the skill.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/skills/{skill_id}/versions/{version}/content",
  "parameter": "version",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The skill version number.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/skills",
  "_fragment": "generated/fragments/parameters/openai-tools.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads",
  "parameter": "filename",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the file to upload.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads",
  "parameter": "purpose",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "assistants",
   "batch",
   "fine-tune",
   "vision"
  ],
  "description": "The intended purpose of the uploaded file.\n\nSee the [documentation on File\npurposes](https://developers.openai.com/api/reference/resources/files/methods/create#%28resource%29%20files%20%3E%20%28method%29%20create%20%3E%20%28params%29%200%20%3E%20%28param%29%20purpose%20%3E%20%28schema%29).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads",
  "parameter": "bytes",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of bytes in the file you are uploading.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads",
  "parameter": "mime_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The MIME type of the file.\n\n\nThis must fall within the supported MIME types for your file purpose. See\nthe supported MIME types for assistants and vision.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads",
  "parameter": "expires_after",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The expiration policy for a file. By default, files with `purpose=batch` expire after 30 days and all other files are persisted until they are manually deleted. [schema: FileExpirationAfter]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads",
  "parameter": "expires_after.anchor",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at"
  ],
  "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads",
  "parameter": "expires_after.seconds",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 3600,
  "maximum": 2592000,
  "enum": null,
  "description": "The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads/{upload_id}/cancel",
  "parameter": "upload_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the Upload.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads/{upload_id}/complete",
  "parameter": "upload_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the Upload.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads/{upload_id}/complete",
  "parameter": "part_ids",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ordered list of Part IDs.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads/{upload_id}/complete",
  "parameter": "md5",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads/{upload_id}/parts",
  "parameter": "upload_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the Upload.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/uploads/{upload_id}/parts",
  "parameter": "data",
  "location": "body(multipart)",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The chunk of bytes for this Part.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/uploads",
  "_fragment": "generated/fragments/parameters/openai-uploads.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "file_ids",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of [File](https://developers.openai.com/api/reference/resources/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the vector store.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description for the vector store. Can be used to describe the vector store's purpose.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "expires_after",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The expiration policy for a vector store. [schema: VectorStoreExpirationAfter]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "expires_after.anchor",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "last_active_at"
  ],
  "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "expires_after.days",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 365,
  "enum": null,
  "description": "The number of days after the anchor time that the vector store will expire.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "chunking_strategy",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "chunking_strategy.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "static"
  ],
  "description": "Always `static`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "chunking_strategy.static",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: StaticChunkingStrategy]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "chunking_strategy.static.max_chunk_size_tokens",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 100,
  "maximum": 4096,
  "enum": null,
  "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "chunking_strategy.static.chunk_overlap_tokens",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: Metadata]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store to modify.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the vector store.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}",
  "parameter": "expires_after",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}",
  "parameter": "expires_after.anchor",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "last_active_at"
  ],
  "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}",
  "parameter": "expires_after.days",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 365,
  "enum": null,
  "description": "The number of days after the anchor time that the vector store will expire.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}",
  "parameter": "metadata",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: Metadata]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/vector_stores/{vector_store_id}",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store for which to create a File Batch.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "file_ids",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of [File](https://developers.openai.com/api/reference/resources/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files. If `attributes` or `chunking_strategy` are provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `files`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "files",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of objects that each include a `file_id` plus optional `attributes` or `chunking_strategy`. Use this when you need to override metadata for specific files. The global `attributes` or `chunking_strategy` will be ignored and must be specified for each file. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive with `file_ids`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "files[].file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A [File](https://developers.openai.com/api/reference/resources/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create) to minimize per-vector-store write requests.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "files[].chunking_strategy",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. [schema: ChunkingStrategyRequestParam]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "files[].chunking_strategy.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "static"
  ],
  "description": "Always `static`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "files[].chunking_strategy.static",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: StaticChunkingStrategy]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "files[].attributes",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: VectorStoreFileAttributes]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "chunking_strategy",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. [schema: ChunkingStrategyRequestParam]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "chunking_strategy.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "static"
  ],
  "description": "Always `static`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "chunking_strategy.static",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: StaticChunkingStrategy]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "chunking_strategy.static.max_chunk_size_tokens",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 100,
  "maximum": 4096,
  "enum": null,
  "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "chunking_strategy.static.chunk_overlap_tokens",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches",
  "parameter": "attributes",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: VectorStoreFileAttributes]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store that the file batch belongs to.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file batch being retrieved.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store that the file batch belongs to.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file batch to cancel.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store that the files belong to.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file batch that the files belong to.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files",
  "parameter": "filter",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "failed",
   "cancelled"
  ],
  "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store that the files belong to.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files",
  "parameter": "before",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files",
  "parameter": "filter",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "in_progress",
   "completed",
   "failed",
   "cancelled"
  ],
  "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store for which to create a File.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files",
  "parameter": "file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A [File](https://developers.openai.com/api/reference/resources/files) ID that the vector store should use. Useful for tools like `file_search` that can access files. For multi-file ingestion, we recommend [`file_batches`](https://developers.openai.com/api/reference/resources/vector_stores/subresources/file_batches/methods/create) to minimize per-vector-store write requests.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files",
  "parameter": "chunking_strategy",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. [schema: ChunkingStrategyRequestParam]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files",
  "parameter": "chunking_strategy.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "static"
  ],
  "description": "Always `static`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files",
  "parameter": "chunking_strategy.static",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: StaticChunkingStrategy]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files",
  "parameter": "chunking_strategy.static.max_chunk_size_tokens",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": 100,
  "maximum": 4096,
  "enum": null,
  "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files",
  "parameter": "chunking_strategy.static.chunk_overlap_tokens",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files",
  "parameter": "attributes",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: VectorStoreFileAttributes]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files/{file_id}",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store that the file belongs to.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file being retrieved.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/vector_stores/{vector_store_id}/files/{file_id}",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store that the file belongs to.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/vector_stores/{vector_store_id}/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files/{file_id}",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store the file belongs to.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file to update attributes.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files/{file_id}",
  "parameter": "attributes",
  "location": "body",
  "type": "object | null",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[schema: VectorStoreFileAttributes]",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files/{file_id}/content",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/vector_stores/{vector_store_id}/files/{file_id}/content",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the file within the vector store.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "vector_store_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the vector store to search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "query",
  "location": "body",
  "type": "string | array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A query string for a search",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "rewrite_query",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to rewrite the natural language query for vector search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "max_num_results",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 10,
  "minimum": 1,
  "maximum": 50,
  "enum": null,
  "description": "The maximum number of results to return. This number should be between 1 and 50 inclusive.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "filters",
  "location": "body",
  "type": "object | object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A filter to apply based on file attributes.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "filters.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "and",
   "or"
  ],
  "description": "Type of operation: `and` or `or`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "filters.key",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The key to compare against the value.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "filters.value",
  "location": "body",
  "type": "string | number | boolean | array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The value to compare against the attribute key; supports string, number, or boolean types.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "filters.filters",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "filters.filters[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": "eq",
  "minimum": null,
  "maximum": null,
  "enum": [
   "eq",
   "ne",
   "gt",
   "gte",
   "lt",
   "lte",
   "in",
   "nin"
  ],
  "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n- `in`: in\n- `nin`: not in",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "filters.filters[].key",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The key to compare against the value.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "filters.filters[].value",
  "location": "body",
  "type": "string | number | boolean | array",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The value to compare against the attribute key; supports string, number, or boolean types.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "ranking_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ranking options for search.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "ranking_options.ranker",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "none",
   "auto",
   "default-2024-11-15"
  ],
  "description": "Enable re-ranking; set to `none` to disable, which can help reduce latency.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "ranking_options.score_threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 1,
  "enum": null,
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/vector_stores",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/files",
  "parameter": "attributes.<key>",
  "location": "body",
  "type": "string | number | boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 16,
  "enum": null,
  "description": "Attribute map used by search filters: at most 16 keys, each key and string value <= 256 characters (Retrieval guide).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/retrieval#attributes",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "ranking_options.hybrid_search.embedding_weight",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reciprocal-rank-fusion weight for semantic (embedding) matches (alias rrf_embedding_weight). At least one of the two weights must be > 0. Documented in the Retrieval guide only (not in the OpenAPI spec).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/retrieval#ranking",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/vector_stores/{vector_store_id}/search",
  "parameter": "ranking_options.hybrid_search.text_weight",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reciprocal-rank-fusion weight for sparse keyword matches (alias rrf_text_weight). Documented in the Retrieval guide only.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/retrieval#ranking",
  "_fragment": "generated/fragments/parameters/openai-vector-stores.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 32000,
  "enum": null,
  "description": "Text prompt (1-32000 chars) describing subject, camera, lighting, motion.",
  "compatible_models": [
   "sora-2",
   "sora-2-pro",
   "sora-2-2025-10-06",
   "sora-2-pro-2025-10-06",
   "sora-2-2025-12-08"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "sora-2",
  "minimum": null,
  "maximum": null,
  "enum": [
   "sora-2",
   "sora-2-pro",
   "sora-2-2025-10-06",
   "sora-2-pro-2025-10-06",
   "sora-2-2025-12-08"
  ],
  "description": "sora-2 (default) | sora-2-pro | dated snapshots. sora-2 alias -> sora-2-2025-12-08; sora-2-pro -> sora-2-pro-2025-10-06.",
  "compatible_models": [
   "sora-2",
   "sora-2-pro",
   "sora-2-2025-10-06",
   "sora-2-pro-2025-10-06",
   "sora-2-2025-12-08"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos",
  "parameter": "seconds",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "4",
  "minimum": null,
  "maximum": null,
  "enum": [
   "4",
   "8",
   "12",
   "16 (guide)",
   "20 (guide)"
  ],
  "description": "Clip duration as a string. Spec enum '4' | '8' | '12' (default '4'); guide/changelog (2026-03-12): both models also accept '16' and '20'; extensions doc lists 4, 8, 12, 16, 20.",
  "compatible_models": [
   "sora-2",
   "sora-2-pro",
   "sora-2-2025-10-06",
   "sora-2-pro-2025-10-06",
   "sora-2-2025-12-08"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": "Spec enum lags the guide.",
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos",
  "parameter": "size",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "720x1280",
  "minimum": null,
  "maximum": null,
  "enum": [
   "720x1280",
   "1280x720",
   "1024x1792",
   "1792x1024",
   "1080x1920 (pro, guide)",
   "1920x1080 (pro, guide)"
  ],
  "description": "Resolution WIDTHxHEIGHT. Spec enum: 720x1280 (default), 1280x720, 1024x1792, 1792x1024. Guide + pricing add 1080x1920 / 1920x1080 (sora-2-pro only, $0.70/s). 1024p and 1080p are sora-2-pro only.",
  "compatible_models": [
   "sora-2",
   "sora-2-pro",
   "sora-2-2025-10-06",
   "sora-2-pro-2025-10-06",
   "sora-2-2025-12-08"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos",
  "parameter": "input_reference",
  "location": "body",
  "type": "file (multipart) | {file_id?, image_url?} (JSON)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional first-frame image reference. Multipart: upload bytes (`-F input_reference=@img.jpeg;type=image/jpeg`). JSON/Batch: object with exactly one of file_id or image_url (data URL allowed, <= 20 MiB). Images with human faces are rejected.",
  "compatible_models": [
   "sora-2",
   "sora-2-pro",
   "sora-2-2025-10-06",
   "sora-2-pro-2025-10-06",
   "sora-2-2025-12-08"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos",
  "parameter": "characters",
  "location": "body",
  "type": "array<{id: string}>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 2,
  "enum": null,
  "description": "Reusable character ids from POST /v1/videos/characters (max 2 per video); mention the character name verbatim in the prompt. Combinable with input_reference; not supported by extensions.",
  "compatible_models": [
   "sora-2",
   "sora-2-pro",
   "sora-2-2025-10-06",
   "sora-2-pro-2025-10-06",
   "sora-2-2025-12-08"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "UNVERIFIED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/video-generation",
  "notes": "Documented only in the guide; ABSENT from the OpenAPI spec bodies (CreateVideoJsonBody/MultipartBody).",
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/videos",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor: id of the last item of the previous page.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/videos",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Page size.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": "limit=2 accepted live.",
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/videos",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "asc | desc by timestamp.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/videos/{video_id}",
  "parameter": "video_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Video job id (must start with 'video').",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": "Live: a path segment not starting with 'video' -> 400 invalid_value param=video_id.",
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/videos/{video_id}",
  "parameter": "video_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Video job id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/videos/{video_id}/content",
  "parameter": "video_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Video job id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/videos/{video_id}/content",
  "parameter": "variant",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "video",
  "minimum": null,
  "maximum": null,
  "enum": [
   "video",
   "thumbnail",
   "spritesheet"
  ],
  "description": "video (default, MP4) | thumbnail (webp) | spritesheet (jpg).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": "variant=thumbnail accepted live (asset expired -> 404).",
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/{video_id}/remix",
  "parameter": "video_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Completed source video id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/{video_id}/remix",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Updated prompt for the remix.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "video",
  "location": "body",
  "type": "{id: string} (JSON) | file (multipart)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Completed video to edit (id) or an uploaded MP4 (eligible customers only). Model is inferred from the id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 32000,
  "enum": null,
  "description": "How to edit the source video (1-32000 chars). Keep to one clear adjustment.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "sora-2",
   "sora-2-pro",
   "sora-2-2025-10-06",
   "sora-2-pro-2025-10-06",
   "sora-2-2025-12-08"
  ],
  "description": "Required only when uploading a new video (multipart).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/docs/guides/video-generation",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "video",
  "location": "body",
  "type": "{id: string} (JSON) | file (multipart)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Completed video to extend.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 32000,
  "enum": null,
  "description": "How the scene continues (1-32000 chars).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "seconds",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "4",
   "8",
   "12",
   "16",
   "20"
  ],
  "description": "Length of the new segment: 4, 8, 12, 16, 20 (spec enum only lists 4/8/12). Up to 6 extensions, 120 s total.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/characters",
  "parameter": "video",
  "location": "body",
  "type": "file (multipart, video/mp4)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Short clip (2-4 s, 16:9 or 9:16, 720p-1080p) of a non-human subject.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/videos/characters",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 80,
  "enum": null,
  "description": "Display name (1-80 chars); must be used verbatim in prompts.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/videos/characters/{character_id}",
  "parameter": "character_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Character id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://developers.openai.com/api/reference/resources/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/openai-videos.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/webhook_endpoints",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Maximum number of webhook endpoints to return. Defaults to 20.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/webhook_endpoints",
  "parameter": "after",
  "location": "query",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the last webhook endpoint from the previous page.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": 1,
  "maximum": 256,
  "enum": null,
  "description": "A human-readable name for the webhook endpoint.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints",
  "parameter": "url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": 2048,
  "enum": null,
  "description": "The HTTPS URL that receives webhook deliveries.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints",
  "parameter": "event_types",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "batch.completed",
   "batch.failed",
   "batch.expired",
   "batch.cancelled",
   "response.completed",
   "response.failed",
   "response.cancelled",
   "response.incomplete",
   "eval.run.succeeded",
   "eval.run.failed",
   "eval.run.canceled",
   "fine_tuning.job.succeeded",
   "fine_tuning.job.failed",
   "fine_tuning.job.cancelled",
   "realtime.call.incoming",
   "video.completed",
   "video.failed",
   "safety.alert.created"
  ],
  "description": "The event types that trigger deliveries to this endpoint.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "GET /v1/webhook_endpoints/{webhook_endpoint_id}",
  "parameter": "webhook_endpoint_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the webhook endpoint to retrieve.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints/{webhook_endpoint_id}",
  "parameter": "webhook_endpoint_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the webhook endpoint to update.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints/{webhook_endpoint_id}",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": 256,
  "enum": null,
  "description": "A new human-readable name for the webhook endpoint.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints/{webhook_endpoint_id}",
  "parameter": "url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 2048,
  "enum": null,
  "description": "A new HTTPS URL that receives webhook deliveries.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints/{webhook_endpoint_id}",
  "parameter": "event_types",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "batch.completed",
   "batch.failed",
   "batch.expired",
   "batch.cancelled",
   "response.completed",
   "response.failed",
   "response.cancelled",
   "response.incomplete",
   "eval.run.succeeded",
   "eval.run.failed",
   "eval.run.canceled",
   "fine_tuning.job.succeeded",
   "fine_tuning.job.failed",
   "fine_tuning.job.cancelled",
   "realtime.call.incoming",
   "video.completed",
   "video.failed",
   "safety.alert.created"
  ],
  "description": "The complete set of event types that should trigger deliveries.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "DELETE /v1/webhook_endpoints/{webhook_endpoint_id}",
  "parameter": "webhook_endpoint_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the webhook endpoint to delete.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints/{webhook_endpoint_id}/rotate_secret",
  "parameter": "webhook_endpoint_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the webhook endpoint whose signing secret will be rotated.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints/{webhook_endpoint_id}/rotate_secret",
  "parameter": "keep_old_secret_active_for_24_hours",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to keep the previous signing secret valid for 24 hours after rotation. Defaults to false, which invalidates the previous secret immediately.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints/{webhook_endpoint_id}/test",
  "parameter": "webhook_endpoint_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the webhook endpoint to test.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST /v1/webhook_endpoints/{webhook_endpoint_id}/test",
  "parameter": "event_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "batch.completed",
   "batch.failed",
   "batch.expired",
   "batch.cancelled",
   "response.completed",
   "response.failed",
   "response.cancelled",
   "response.incomplete",
   "eval.run.succeeded",
   "eval.run.failed",
   "eval.run.canceled",
   "fine_tuning.job.succeeded",
   "fine_tuning.job.failed",
   "fine_tuning.job.cancelled",
   "realtime.call.incoming",
   "video.completed",
   "video.failed",
   "safety.alert.created"
  ],
  "description": "",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/overview",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://auth.openai.com/oauth/token",
  "parameter": "grant_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "urn:ietf:params:oauth:grant-type:token-exchange"
  ],
  "description": "Must be urn:ietf:params:oauth:grant-type:token-exchange.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/workload-identity-federation",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://auth.openai.com/oauth/token",
  "parameter": "subject_token_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "urn:ietf:params:oauth:token-type:jwt",
   "urn:ietf:params:oauth:token-type:id_token",
   "urn:openai:params:oauth:token-type:x509"
  ],
  "description": "JWT exchange: urn:ietf:params:oauth:token-type:jwt or urn:ietf:params:oauth:token-type:id_token. X.509 exchange: urn:openai:params:oauth:token-type:x509.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/workload-identity-federation",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://auth.openai.com/oauth/token",
  "parameter": "subject_token",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Externally issued OIDC JWT or SPIFFE JWT-SVID (required for JWT exchange; must be OMITTED for X.509 exchange). Must carry kid+alg header and iss, aud, sub, exp, iat claims matching the provider.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/workload-identity-federation",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://auth.openai.com/oauth/token",
  "parameter": "identity_provider_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OpenAI Workload Identity Provider ID configured for the external issuer.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/workload-identity-federation",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://auth.openai.com/oauth/token",
  "parameter": "service_account_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OpenAI service account ID resolved against the provider's service-account mappings (exactly one enabled mapping must match).",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/workload-identity-federation",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "openai",
  "endpoint": "POST https://auth.openai.com/oauth/token",
  "parameter": "scope",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ignored for authorization: a scope value in the request does not grant access; effective permissions come from the mapping.",
  "compatible_models": [],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://developers.openai.com/api/reference/workload-identity-federation",
  "_fragment": "generated/fragments/parameters/openai-webhooks.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "deferred",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to `true`, the request returns a `request_id`. You can then get the deferred response by GET `/v1/chat/deferred-completion/{request_id}`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: true → 200 {request_id}; GET /v1/chat/deferred-completion/{id} 202 then 200",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "frequency_penalty",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 0,
  "minimum": -2,
  "maximum": 2,
  "enum": null,
  "description": "(Not supported by reasoning models) 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.",
  "compatible_models": [
   "grok-4.20-0309-non-reasoning"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "float",
  "live_note": "2026-09-18: not isolated (sent with presence_penalty which was rejected first); docs: not supported by reasoning models",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "logit_bias",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) A JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "rejected_400",
  "live_note": "2026-09-18: → 400 'Argument not supported: logit_bias'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "logprobs",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": 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. Not supported by models `grok-4.20` and newer; the field will be silently ignored if set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "ignored",
  "live_note": "2026-09-18: accepted (200) but choices[0].logprobs=null on grok-4.3 (silently ignored as documented for grok-4.20+)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "max_completion_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An upper bound for the number of tokens that can be generated for a completion, only applies to visible output tokens (i.e. does not apply to tokens used for reasoning or function calls). Defaults to 128,000 when unset; set a larger value to allow longer generations.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "int32",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 32 accepted; counts visible output only (reasoning tokens not capped by it)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "max_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "\\[DEPRECATED\\] The maximum number of tokens that can be generated in the chat completion. Deprecated in favor of `max_completion_tokens`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "int32",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: still accepted (200) alongside other fields; deprecated alias",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages",
  "location": "body",
  "type": "array<Message>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of messages that make up the chat conversation. Different models support different message types, such as image and text.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: system/user/assistant/tool roles round-tripped; `developer` role accepted (200)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content",
  "location": "body",
  "type": "Content",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System prompt content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=system",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content[].file",
  "location": "body",
  "type": "null | FileRef",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "content part (any role)",
  "live_note": "2026-09-18: text + image_url (32x32 PNG data URL, detail=low → image_tokens=3) verified; `file` part → 400 'File content is not supported on /v1/chat/completions. Please use /v1/responses instead.'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content[].file.file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file ID from the Files API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "content part (any role)",
  "nullable": true,
  "live_note": "2026-09-18: text + image_url (32x32 PNG data URL, detail=low → image_tokens=3) verified; `file` part → 400 'File content is not supported on /v1/chat/completions. Please use /v1/responses instead.'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content[].file.url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public URL for a file attachment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "content part (any role)",
  "nullable": true,
  "live_note": "2026-09-18: text + image_url (32x32 PNG data URL, detail=low → image_tokens=3) verified; `file` part → 400 'File content is not supported on /v1/chat/completions. Please use /v1/responses instead.'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content[].image_url",
  "location": "body",
  "type": "null | ImageUrl",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "content part (any role)",
  "live_note": "2026-09-18: text + image_url (32x32 PNG data URL, detail=low → image_tokens=3) verified; `file` part → 400 'File content is not supported on /v1/chat/completions. Please use /v1/responses instead.'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content[].image_url.file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File ID from the xAI Files API. Mutually exclusive with `url`.\nThe file must be an image (JPEG, PNG, or WebP) and fully uploaded.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "content part (any role)",
  "nullable": true,
  "live_note": "2026-09-18: text + image_url (32x32 PNG data URL, detail=low → image_tokens=3) verified; `file` part → 400 'File content is not supported on /v1/chat/completions. Please use /v1/responses instead.'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content[].image_url.url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public URL or base64-encoded data URL of the image (JPEG, PNG, or WebP).\nAlso accepts `image_url` for compatibility.\nRequired when `file_id` is not set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "content part (any role)",
  "live_note": "2026-09-18: text + image_url (32x32 PNG data URL, detail=low → image_tokens=3) verified; `file` part → 400 'File content is not supported on /v1/chat/completions. Please use /v1/responses instead.'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content[].text",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text prompt.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "content part (any role)",
  "nullable": true,
  "live_note": "2026-09-18: text + image_url (32x32 PNG data URL, detail=low → image_tokens=3) verified; `file` part → 400 'File content is not supported on /v1/chat/completions. Please use /v1/responses instead.'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the content part. Can be `text`, `image_url`, `text_file` or `file`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "content part (any role)",
  "live_note": "2026-09-18: text + image_url (32x32 PNG data URL, detail=low → image_tokens=3) verified; `file` part → 400 'File content is not supported on /v1/chat/completions. Please use /v1/responses instead.'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=system",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "system"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=system",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content",
  "location": "body",
  "type": "Content",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System prompt content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=user",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=user",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "user"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=user",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content",
  "location": "body",
  "type": "null | Content",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].reasoning_content",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Assistant reasoning content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "assistant"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].tool_calls",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of tool calls available to the model on your machine.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].tool_calls[].function",
  "location": "body",
  "type": "Function",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Function to call for the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].tool_calls[].function.arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].tool_calls[].function.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].tool_calls[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique ID of the tool call generated by xAI. After performing tool call's function, user provides this ID with tool call's result in the subsequent request to xAI. xAI can then match the tool call result sent with tool call request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].tool_calls[].index",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Index of the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].tool_calls[].type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Type of tool call, should be `\"function\"` or `\"web_search_call\"` or `\"x_search_call\"` or `\"code_interpreter_call\"` or `\"mcp_call\"`",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=assistant",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content",
  "location": "body",
  "type": "Content",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Content of the tool call result.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=tool",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=tool",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].tool_call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the tool call received from assistant message response.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=tool",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].content",
  "location": "body",
  "type": "Content",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Content of the tool call result.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=function",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=function",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "messages[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "role=function",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model name for the model to use. Obtainable from <https://console.x.ai/team/default/models> or <https://docs.x.ai/docs/models>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: grok-4.3, grok-4.20-0309-non-reasoning",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "n",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": 1,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "int32",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: n=2 → 2 choices",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to false, the model can perform maximum one tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: false → exactly 1 tool call where default produced 2",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "presence_penalty",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 0,
  "minimum": -2,
  "maximum": 2,
  "enum": null,
  "description": "(Not supported by `grok-3` and reasoning models) 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.",
  "compatible_models": [
   "grok-4.20-0309-non-reasoning"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "float",
  "live_behavior": "rejected_400_on_reasoning_models",
  "live_note": "2026-09-18: grok-4.3 → 400 'Model grok-4.3 does not support parameter presencePenalty'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "prompt_cache_key",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A stable cache key for best-effort sticky routing / prompt-cache hits\nacross requests sharing a prompt prefix. Plumbed to `x-grok-conv-id`,\nsame as on `/v1/responses`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: same key + x-grok-conv-id header, 2 identical 920-token prompts: cached_tokens 192 → 896",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "reasoning_effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh",
   "none (LIVE_DISCOVERED, grok-4.3)"
  ],
  "description": "Constrains how hard a reasoning model thinks before responding. Higher efforts use more reasoning tokens for deeper thinking. The supported values and the default depend on the model.",
  "compatible_models": [
   "grok-4.6",
   "grok-4.5",
   "grok-4.3",
   "grok-4.20-0309-reasoning",
   "grok-4.20-multi-agent-0309",
   "grok-build-0.1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: grok-4.3 accepts low/medium/high/xhigh (200) and undocumented `none` (200, reasoning_tokens=0); grok-4.20-0309-non-reasoning → 400 'does not support parameter reasoningEffort'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format",
  "location": "body",
  "type": "null | ResponseFormat",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: json_schema strict + json_object → valid JSON",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=text",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_object"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=json_object",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format.json_schema",
  "location": "body",
  "type": "any",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A json schema representing the desired response schema. Includes the schema as a `\"schema\"` field.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=json_schema",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "response_format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_schema"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=json_schema",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "safety_identifier",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Supplied by the API client to identify the end user behind this request. A stable string that uniquely identifies each of your users; hash your internal user id or username rather than sending an email or name. Stored with the request metadata so a usage-policy violation can be attributed to that user rather than to the API key.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: accepted",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters",
  "location": "body",
  "type": "null | SearchParameters",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "rejected_410",
  "live_note": "2026-09-18: → 410 'Live search is deprecated. Please switch to the Agent Tools API'",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.from_date",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Date from which to consider the results in ISO-8601 YYYY-MM-DD. See\n<https://en.wikipedia.org/wiki/ISO_8601>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "date",
  "live_note": "2026-09-18: parent object rejected with 410 (Live Search retired)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.max_search_results",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": 15,
  "minimum": 1,
  "maximum": 30,
  "enum": null,
  "description": "Maximum number of search results to use.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "int32",
  "live_note": "2026-09-18: parent object rejected with 410 (Live Search retired)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.mode",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Choose the mode to query realtime data:\n* `off`: no search performed and no external will be considered.\n* `on` (default): the model will search in every sources for relevant data.\n* `auto`: the model choose whether to search data or not and where to search the data.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_note": "2026-09-18: parent object rejected with 410 (Live Search retired)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.return_citations",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to return citations in the response or not.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_note": "2026-09-18: parent object rejected with 410 (Live Search retired)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of sources to search in. If no sources specified, the model will look over the web and X by default.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_note": "2026-09-18: parent object rejected with 410 (Live Search retired)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].excluded_x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of X handles to exclude from the search results. X posts returned will not include\nany posts authored by these handles.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].included_x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "NOTE: `included_x_handles` and `x_handles` are the same parameter.\n`included_x_handles` is the new name but we keep both for backward compatibility.\n\nX Handles of the users from whom to consider the posts. Only available if mode is `auto`, `on` or `x`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].post_favorite_count",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The minimum favorite count of the X posts to consider.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].post_view_count",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The minimum view count of the X posts to consider.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "x"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "DEPRECATED in favor of `included_x_handles`. Use `included_x_handles` instead.\nX Handles of the users from whom to consider the posts. Only available if mode is `auto`, `on` or `x`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "deprecated": true,
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].allowed_websites",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website to allow in the search results. This parameter act as a whitelist\nwhere only those websites can be selected. A maximum of 5 websites can be selected.\n\nNote 1: If no relevant information is found on those websites, the number of results\nreturned might be smaller than `max_search_results`.\n\nNote 2: This parameter cannot be set with `excluded_websites`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ISO alpha-2 code of the country. If the country is set, only data coming from this country\nwill be considered. See <https://en.wikipedia.org/wiki/ISO_3166-2>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "nullable": true,
  "format": "iso3166-1-alpha-2",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].excluded_websites",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website to exclude from the search results without protocol specification or\nsubdomains. A maximum of 5 websites can be excluded.\n\nNote 2: This parameter cannot be set with `allowed_websites`",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].safe_search",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to true, mature content won't be considered during the search. Default to `true`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "web"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ISO alpha-2 code of the country. If the country is set, only data coming from this country\nwill be considered. See <https://en.wikipedia.org/wiki/ISO_3166-2>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=news",
  "nullable": true,
  "format": "iso3166-1-alpha-2",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].excluded_websites",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website to exclude from the search results without protocol specification or\nsubdomains. A maximum of 5 websites can be excluded.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=news",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].safe_search",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to true, mature content won't be considered during the search. Default to `true`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=news",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "news"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=news",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].links",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Links of the RSS feeds.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=rss",
  "max_items": 1,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "rss"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=rss",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "search_parameters.to_date",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Date up to which to consider the results in ISO-8601 YYYY-MM-DD. See\n<https://en.wikipedia.org/wiki/ISO_8601>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "date",
  "live_note": "2026-09-18: parent object rejected with 410 (Live Search retired)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": 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. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "int32",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: accepted; system_fingerprint returned (fp_eb3c003fc66c14ed)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "service_tier",
  "location": "body",
  "type": "null | ServiceTier",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "default",
   "priority"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 'priority' → 200 with response.service_tier='priority' (billed 2x)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stop",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Not supported by reasoning models) Up to 4 sequences where the API will stop generating further tokens.",
  "compatible_models": [
   "grok-4.20-0309-non-reasoning"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "rejected_400_on_reasoning_models",
  "live_note": "2026-09-18: on /v1/messages the equivalent stop_sequences → 400 'Model grok-4.3 does not support parameter stop'; docs: not supported by reasoning models",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set, partial message deltas 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: data-only SSE, 4 chunks + usage chunk + [DONE]",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stream_options",
  "location": "body",
  "type": "null | StreamOptions",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: include_usage:true → final chunk choices=[] with usage",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "stream_options.include_usage",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Set an additional chunk to be streamed before the `data: [DONE]` message. The other chunks will return `null` in `usage` field.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: final usage chunk observed",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice",
  "location": "body",
  "type": "null | ToolChoice",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 'required', 'none', {type:function,function:{name}} accepted",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.function",
  "location": "body",
  "type": "null | FunctionChoice",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.function.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tool_choice.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Type is always `\"function\"`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools the model may call in JSON-schema. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 350 functions are supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "max_items": 350,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: function tools: forced, parallel (2 calls), round trip, streaming. Only `function` and `live_search` variants deserialize; `{type:web_search}` → 422 unknown variant",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function",
  "location": "body",
  "type": "FunctionDefinition",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Definition of tool call available to the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=function",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function.defer_loading",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, the definition is hidden from the model's prompt but stays\ncallable, loaded via a `tool_search` step (`/v1/responses` only).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=function",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function.description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of the function to indicate to the model when to call it.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=function",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function. If the model calls the function, this name is used in the\nresponse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=function",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function.parameters",
  "location": "body",
  "type": "any",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON schema describing the function parameters. The model _should_ follow the schema,\nhowever, this is not enforced at the moment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=function",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].function.strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Not supported. Only maintained for compatibility reasons.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=function",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=function",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources",
  "location": "body",
  "type": "array<SearchSource>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=live_search",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].excluded_x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of X handles to exclude from the search results. X posts returned will not include\nany posts authored by these handles.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].included_x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "NOTE: `included_x_handles` and `x_handles` are the same parameter.\n`included_x_handles` is the new name but we keep both for backward compatibility.\n\nX Handles of the users from whom to consider the posts. Only available if mode is `auto`, `on` or `x`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].post_favorite_count",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The minimum favorite count of the X posts to consider.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].post_view_count",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The minimum view count of the X posts to consider.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "x"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "DEPRECATED in favor of `included_x_handles`. Use `included_x_handles` instead.\nX Handles of the users from whom to consider the posts. Only available if mode is `auto`, `on` or `x`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=x",
  "deprecated": true,
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].allowed_websites",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website to allow in the search results. This parameter act as a whitelist\nwhere only those websites can be selected. A maximum of 5 websites can be selected.\n\nNote 1: If no relevant information is found on those websites, the number of results\nreturned might be smaller than `max_search_results`.\n\nNote 2: This parameter cannot be set with `excluded_websites`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ISO alpha-2 code of the country. If the country is set, only data coming from this country\nwill be considered. See <https://en.wikipedia.org/wiki/ISO_3166-2>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "nullable": true,
  "format": "iso3166-1-alpha-2",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].excluded_websites",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website to exclude from the search results without protocol specification or\nsubdomains. A maximum of 5 websites can be excluded.\n\nNote 2: This parameter cannot be set with `allowed_websites`",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].safe_search",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to true, mature content won't be considered during the search. Default to `true`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "web"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=web",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ISO alpha-2 code of the country. If the country is set, only data coming from this country\nwill be considered. See <https://en.wikipedia.org/wiki/ISO_3166-2>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=news",
  "nullable": true,
  "format": "iso3166-1-alpha-2",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].excluded_websites",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website to exclude from the search results without protocol specification or\nsubdomains. A maximum of 5 websites can be excluded.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=news",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].safe_search",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to true, mature content won't be considered during the search. Default to `true`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=news",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "news"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=news",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].links",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Links of the RSS feeds.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=rss",
  "max_items": 1,
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "rss"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=rss",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "live_search"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "variant": "type=live_search",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "top_logprobs",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 8,
  "enum": null,
  "description": "An integer between 0 and 8 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. Not supported by models `grok-4.20` and newer; the field will be silently ignored if set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "int32",
  "live_behavior": "ignored",
  "live_note": "2026-09-18: accepted, ignored on grok-4.3",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": 1,
  "enum": null,
  "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. It is generally recommended to alter this or `temperature` but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "user",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: accepted",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options",
  "location": "body",
  "type": "null | WebSearchOptions",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "rejected_410",
  "live_note": "2026-09-18: → 410 'Live search is deprecated' (same as search_parameters)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.filters",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_note": "2026-09-18: parent object rejected with 410 (Live Search retired)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.search_context_size",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "medium",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "This field included for compatibility reason with OpenAI's API. It is mapped to `max_search`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "nullable": true,
  "live_note": "2026-09-18: parent object rejected with 410 (Live Search retired)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "web_search_options.user_location",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_note": "2026-09-18: parent object rejected with 410 (Live Search retired)",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "store",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OpenAI field; NOT in the xAI OpenAPI spec. Live: accepted silently (200), no stored-completion retrieval endpoints exist on xAI (GET /v1/chat/completions/{id} not offered).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "ignored",
  "live_note": "2026-09-18: 200, silently accepted",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "metadata",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OpenAI field; not in xAI spec. Live: silently accepted on chat completions (contrast: /v1/responses rejects it with 400).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "live_behavior": "ignored",
  "live_note": "2026-09-18: 200",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/chat/completions",
  "parameter": "x-grok-conv-id",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Conversation/sticky-routing key for prompt caching (same effect as body prompt_cache_key).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/advanced-api-usage/prompt-caching/maximizing-cache-hits",
  "live_note": "2026-09-18: cached_tokens grew 192→896 on the second identical request",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/chat/deferred-completion/{request_id}",
  "parameter": "request_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The deferred request id returned by a previous `deferred: true` chat request. 202 (empty body) while pending, 200 ChatResponse when done; result stays fetchable (a second GET also returned 200; docs say exactly once within 24 h).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/chat-completions",
  "_fragment": "generated/fragments/parameters/xai-chat-completions.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/files",
  "parameter": "expires_after",
  "location": "multipart",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional TTL in seconds (measured from upload time). Must be between\n3600 (1 hour) and 2592000 (30 days). If unset the file does not expire.\n\nAccepts either a plain integer or the OpenAI SDK deepObject form\n(`expires_after[anchor]=created_at` + `expires_after[seconds]=N`)\nas separate multipart fields. The anchor+seconds form must arrive\nbefore the `file` part.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/upload",
  "nullable": true,
  "format": "int64",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 3600 accepted when sent BEFORE the file part → expires_at = created_at+3600",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/files",
  "parameter": "file",
  "location": "multipart",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file to upload. The filename from the multipart\n`Content-Disposition: filename=` header is recorded as the file's\n`filename`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/upload",
  "format": "binary",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 200-byte text/plain and 95-byte PNG uploaded (multipart)",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/files",
  "parameter": "purpose",
  "location": "multipart",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional purpose label, accepted for OpenAI SDK compatibility. xAI\ndoes not enforce or interpret this field. Setting `\"assistants\"`\nis the conventional choice.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/upload",
  "nullable": true,
  "live_behavior": "ignored",
  "live_note": "2026-09-18: 'assistants' sent; echoed as purpose:'' (not stored)",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/files",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 100,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max objects per page (1-100, default 100).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/manage",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/files",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "asc | desc (default desc).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/manage",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/files",
  "parameter": "sort_by",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "created_at",
  "minimum": null,
  "maximum": null,
  "enum": [
   "created_at",
   "filename",
   "size"
  ],
  "description": "created_at | filename | size (default created_at).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/manage",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/files",
  "parameter": "pagination_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Token from the previous page. Live: null when the page is the last one.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/manage",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/files",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for OpenAI compatibility. Use pagination_token instead.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/manage",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/files",
  "parameter": "filter",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "AIP-160 filter (name/file_name, file_id, size_bytes, content_type, created_at, expires_at, upload_status, user_defined_id, public_url). Live: `public_url != null` matched the file with an active public URL.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/manage",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File id → File metadata (404 after delete: {code:'not-found', error:'File not found'}).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/manage",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "DELETE /v1/files/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File id → {id, deleted:true, object:'file'}.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/manage",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/files/{file_id}/content",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File id → raw bytes (200, 200 bytes matched the upload).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/download",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/files/{file_id}/content",
  "parameter": "format",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "original",
   "text"
  ],
  "description": "original | text. Live: format=text on a text/plain file → 404 {error:'Failed to retrieve file'} (text extraction not available for that type).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/files/download",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/files/{file_id}/public-url",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File id (content type must be png/jpeg/gif/webp/mp4/webm/pdf; text/plain → 400).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/files/public-urls",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/files/{file_id}/public-url/revoke",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "File id → {id, revoked:true, public_url} or {id, revoked:false} when nothing to revoke.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/files/public-urls",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/files/{file_id}/public-url",
  "parameter": "expires_after",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Seconds from now until the public URL expires. Must be between `3600` (1\nhour) and `2592000` (30 days). Omit to inherit the file's expiry (if it\nhas one) or to make the URL valid indefinitely.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/files/public-urls",
  "nullable": true,
  "format": "int64",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 3600 on a file expiring in 3600 s → 400 'cannot exceed the file's expiry time. Set expires_after to at most 3599s'; {} on a non-expiring PNG → 200; second call with 3600 → same URL + expires_at (idempotent update)",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "filter",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional metadata filter string to apply to search results.\nUses AIP-160 filter syntax for querying document metadata.\nSupports comparison operators: `=`, `!=`, `>`, `>=`, `<`, `<=`\nSupports logical operators: `AND`, `OR`\nSupports range syntax: `field:10..20` (inclusive)\nExamples: `author = \"John\"` or `year > 2020 AND category = \"finance\"`",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "group_by",
  "location": "body",
  "type": "null | GroupBy",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "group_by.aggregate",
  "location": "body",
  "type": "null | GroupByAggregate",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "group_by.aggregate.min_k",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Keep the k records with the smallest values (best scores).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "item=Keep the k records with the smallest values (best scores)",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "group_by.aggregate.min_k.k",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of records to keep per group. Must be >= 1.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "item=Keep the k records with the smallest values (best scores)",
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "group_by.aggregate.min_k.keys",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Key(s) to sort by within each group. Use \"#score\" for relevance score.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "item=Keep the k records with the smallest values (best scores)",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "group_by.aggregate.max_k",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Keep the k records with the largest values.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "item=Keep the k records with the largest values",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "group_by.aggregate.max_k.k",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Number of records to keep per group. Must be >= 1.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "item=Keep the k records with the largest values",
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "group_by.aggregate.max_k.keys",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Key(s) to sort by within each group.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "item=Keep the k records with the largest values",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "group_by.keys",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata key(s) to group results by (e.g. \"category\", \"department\").\nAt least one key is required.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-defined instructions to be included in the search query. Defaults to generic search instructions.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "limit",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of chunks to return.\nWill always return the top matching chunks.\nOptional, defaults to 10.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "query",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The query to search for which will be embedded using the\nsame embedding model as the one used for the source to query.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "live_note": "2026-09-18: fake/empty/still-indexing collections → 404 'not found or not accessible' or 400 'Collection IDs cannot be empty'; no processed collection was available within the probe window (document still DOCUMENT_STATUS_PROCESSING after 75 s)",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "ranking_metric",
  "location": "body",
  "type": "null | RankingMetric",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "RANKING_METRIC_UNKNOWN",
   "RANKING_METRIC_L2_DISTANCE",
   "RANKING_METRIC_COSINE_SIMILARITY"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode",
  "location": "body",
  "type": "null | RetrievalMode",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "live_note": "2026-09-18: {type:'hybrid'} accepted",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker",
  "location": "body",
  "type": "null | HybridReranker",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=hybrid",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Instructions for the reranking model. Defaults to generic reranking instructions.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=reranker_model",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker.model",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for reranking. Defaults to standard reranker model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=reranker_model",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "reranker_model"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=reranker_model",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker.embedding_weight",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Weight for embedding (dense) search results. Should be between 0 and 1. Defaults to 0.5.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=rrf",
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker.k",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The RRF constant k used in the reciprocal rank fusion formula. Defaults to 60.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=rrf",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker.text_weight",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Weight for keyword (sparse) search results. Should be between 0 and 1. Defaults to 0.5.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=rrf",
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "rrf"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=rrf",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.search_multiplier",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Additional multiplier to requested search limit.\nValid range is [1, 100]. Defaults to 1 when unset.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=hybrid",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "hybrid"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=hybrid",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker",
  "location": "body",
  "type": "null | RerankerModel",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=semantic",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker.instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Instructions for the reranking model. Defaults to generic reranking instructions.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=semantic",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker.model",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to use for reranking. Defaults to standard reranker model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=semantic",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "semantic"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=semantic",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.reranker",
  "location": "body",
  "type": "null | RerankerModel",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=keyword",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "retrieval_mode.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "keyword"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "variant": "type=keyword",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "source",
  "location": "body",
  "type": "DocumentsSource",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The source to query.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "source.collection_ids",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The collection IDs to search in.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/documents/search",
  "parameter": "source.rag_pipeline",
  "location": "body",
  "type": "null | RagPipeline",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "chroma_db",
   "es"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/search",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "collection_name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the new collection.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "live_note": "2026-09-18: works on https://api.x.ai with the inference key (docs: management-api.x.ai + Management key). On api.x.ai `field_definitions` is REQUIRED (422 'missing field field_definitions' when omitted)",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "team_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Owning team; derived from credentials if omitted.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "collection_description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-friendly description.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "index_configuration.model_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Embedding model (live default echoed: grok-embedding-small).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "One of chars_configuration | tokens_configuration | markdown_tokens_configuration | markdown_chars_configuration | code_tokens_configuration | code_chars_configuration | table_configuration | bytes_configuration | ast_configuration (deprecated) + strip_whitespace, inject_name_into_chunks. Live default echoed: {config:{BytesConfiguration:{max_chunk_size_bytes:4000, chunk_overlap_bytes:800}}, strip_whitespace:true, inject_name_into_chunks:false}.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration.tokens_configuration.max_chunk_size_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max chunk length in tokens.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration.tokens_configuration.chunk_overlap_tokens",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Overlap in tokens (both sides).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration.tokens_configuration.encoding_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Tokenizer encoding, e.g. o200k_base.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration.chars_configuration.max_chunk_size_chars",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max chunk length in characters.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration.chars_configuration.chunk_overlap_chars",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Overlap in characters.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration.bytes_configuration.max_chunk_size_bytes",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max chunk length in bytes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration.bytes_configuration.chunk_overlap_bytes",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Overlap in bytes.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration.strip_whitespace",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Remove leading/trailing whitespace.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "chunk_configuration.inject_name_into_chunks",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inject document name into chunks.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "metric_space",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "HNSW_METRIC_UNKNOWN",
   "HNSW_METRIC_COSINE",
   "HNSW_METRIC_EUCLIDEAN",
   "HNSW_METRIC_INNER_PRODUCT"
  ],
  "description": "HNSW distance space.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "version",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Internal only.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "field_definitions",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Metadata field definitions. Live (api.x.ai): required; may be []. Each item must carry key, required, inject_into_chunk, unique (422 'missing field inject_into_chunk' otherwise) and optionally description.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "field_definitions[].key",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Field key.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "field_definitions[].required",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required for every document.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "field_definitions[].inject_into_chunk",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Prepend value to each chunk (contextual retrieval).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "field_definitions[].unique",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Unique across documents.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections",
  "parameter": "field_definitions[].description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional description.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max 100 (default 100).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "ORDERING_UNKNOWN",
   "ORDERING_ASCENDING",
   "ORDERING_DESCENDING"
  ],
  "description": "Sort order.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections",
  "parameter": "sort_by",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "COLLECTIONS_SORT_BY_NAME",
   "COLLECTIONS_SORT_BY_AGE"
  ],
  "description": "Sort field.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections",
  "parameter": "pagination_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Next-page token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections",
  "parameter": "filter",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter on collection_id, collection_name (partial), created_at, documents_count.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections",
  "parameter": "team_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Owning team.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}",
  "parameter": "collection_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Collection id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "DELETE /v1/collections/{collection_id}",
  "parameter": "collection_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Collection id → 200 {}.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "PUT /v1/collections/{collection_id}",
  "parameter": "collection_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Collection id (path). Live (api.x.ai): body must ALSO contain collection_id and field_definition_updates (422 otherwise).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "PUT /v1/collections/{collection_id}",
  "parameter": "collection_name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New name.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "PUT /v1/collections/{collection_id}",
  "parameter": "collection_description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "New description.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "PUT /v1/collections/{collection_id}",
  "parameter": "chunk_configuration",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Same shape as on create.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "PUT /v1/collections/{collection_id}",
  "parameter": "field_definition_updates",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "[{field_definition:{key,…}, operation: FIELD_DEFINITION_ADD|FIELD_DEFINITION_DELETE}]. Live: required on api.x.ai (may be []).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "PUT /v1/collections/{collection_id}",
  "parameter": "field_definition_updates[].operation",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "FIELD_DEFINITION_ADD",
   "FIELD_DEFINITION_DELETE"
  ],
  "description": "Add/update or delete (cascade) a field definition.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "collection_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Collection id (path). Live (api.x.ai): the JSON body must repeat collection_id AND file_id (gRPC-gateway transcoding) — 422 'missing field collection_id/file_id' otherwise.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files-API file id to attach.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "fields",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "User-defined metadata fields (must match field_definitions).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "live_note": "2026-09-18: {type:'note'} stored and echoed",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "team_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Owning team.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents",
  "parameter": "collection_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Collection id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max 100.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "ORDERING_UNKNOWN",
   "ORDERING_ASCENDING",
   "ORDERING_DESCENDING"
  ],
  "description": "Sort order.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents",
  "parameter": "sort_by",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "DOCUMENTS_SORT_BY_NAME",
   "DOCUMENTS_SORT_BY_SIZE",
   "DOCUMENTS_SORT_BY_AGE"
  ],
  "description": "Sort field.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents",
  "parameter": "pagination_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Next-page token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents",
  "parameter": "filter",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filter on name, content_type, size_bytes, created_at, status, fields.{key}.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents",
  "parameter": "name",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "DEPRECATED: use filter name:value.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "collection_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Collection id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Document (file) id. Live: `status` came back as the proto enum NUMBER 1 (= DOCUMENT_STATUS_PROCESSING) instead of the documented string.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "PATCH /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "collection_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Regenerate indices for the document.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "PATCH /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Document id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "DELETE /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "collection_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Collection id. Live: 200 {} and the underlying Files-API file was DELETED too (GET /v1/files/{id} → 404 afterwards) — even when the document had never been added.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "DELETE /v1/collections/{collection_id}/documents/{file_id}",
  "parameter": "file_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Document id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_DISCOVERED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/collections/{collection_id}/documents:batchGet",
  "parameter": "file_ids",
  "location": "query",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Documented as required query array. Live: `file_ids=<id>` → 400 'invalid type: string, expected a sequence'; `file_ids[]=<id>` → 400 'missing field file_ids' (query encoding unresolved).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "FAILED_VERIFICATION"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/collections/collection",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Human-readable batch name.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "live_note": "2026-09-18: 'atlas-probe' → batch_id batch_…, expire_time = create_time + 30 days",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches",
  "parameter": "input_file_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files-API id of a JSONL file (custom_id/method/url/body per line, ≤200 MB, ≤50,000 requests). File-based batches are sealed (no AddBatchRequests).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/advanced-api-usage/batch-api",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/batches",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Page size.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/batches",
  "parameter": "pagination_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Next-page token (null on last page).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/batches/{batch_id}",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Batch id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Batch id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_requests",
  "location": "body",
  "type": "array<object>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Requests to add (each payload ≤25 MB; ≤1000 add calls / 30 s / team).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "live_note": "2026-09-18: 2 requests added → 200 with EMPTY body (null)",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_requests[].batch_request_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Caller id, unique within the batch (UUID generated if omitted).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_requests[].batch_request",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Exactly one of chat_get_completion | responses | image_generation | image_edit | video_generation | video_extension.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_requests[].batch_request.chat_get_completion",
  "location": "body",
  "type": "ChatRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full /v1/chat/completions body (max 128 functions per docs).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "live_note": "2026-09-18: grok-4.3 'Reply with OK.' → succeeded in <11 s",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_requests[].batch_request.responses",
  "location": "body",
  "type": "ModelRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Full /v1/responses body (server-side tools allowed). Live: accepted, but the result came back under `chat_get_completion` (chat.completion object) and the request metadata endpoint reported `xai_api.Chat/GetCompletion`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "live_note": "2026-09-18: 200; result shape = chat_get_completion",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_requests[].batch_request.image_generation",
  "location": "body",
  "type": "GenerateImageRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image generation body (see images agent).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_requests[].batch_request.image_edit",
  "location": "body",
  "type": "EditImageRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image edit body.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_requests[].batch_request.video_generation",
  "location": "body",
  "type": "GenerateVideoRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Video generation/edit body.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}/requests",
  "parameter": "batch_requests[].batch_request.video_extension",
  "location": "body",
  "type": "ExtendVideoRequest",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Video extension body.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/batches/{batch_id}/requests",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Batch id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/batches/{batch_id}/requests",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max 1000.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/batches/{batch_id}/requests",
  "parameter": "pagination_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Next-page token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/batches/{batch_id}/results",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Batch id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/batches/{batch_id}/results",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max 1000.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/batches/{batch_id}/results",
  "parameter": "pagination_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Next-page token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/batches/{batch_id}:cancel",
  "parameter": "batch_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Batch id → Batch with cancel_time set (works even after completion).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/batches",
  "_fragment": "generated/fragments/parameters/xai-files-collections-batches.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "model",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image model id or alias (grok-imagine-image, grok-imagine-image-2.0, grok-imagine-image-quality → served by 2.0/low from 2026-11-02). Effectively required.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": "grok-2-image → 404 not-found (retired slug).",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Prompt (max_prompt_length: 16000 chars on grok-imagine-image / -quality, 64000 on 2.0 per the models endpoint). Required.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "n",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 1,
  "minimum": 1,
  "maximum": 10,
  "enum": null,
  "description": "Number of images (1–10).",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": "Live: n=0 → 400 {code:'invalid-argument', error:'The number of images to generate (n) must be between 1 and 10 inclusive.'}",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "response_format",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "url",
  "minimum": null,
  "maximum": null,
  "enum": [
   "url",
   "b64_json"
  ],
  "description": "`url` (ephemeral hosted URL) or `b64_json` (bare base64, no data-URI prefix).",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": "Live: 'png' → 400 'Invalid format.'",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "resolution",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "1k",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1k",
   "1.5k",
   "2k"
  ],
  "description": "Output resolution; grok-imagine models only. Pricing on 2.0 rises with resolution (1k < 1.5k < 2k).",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/images/generation",
  "notes": "The guide lists only 1k and 2k; the OpenAPI enum and REST reference also include 1.5k (and the 2.0 pricing matrix prices it).",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "quality",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "auto"
  ],
  "description": "Quality tier for grok-imagine-image-2.0: low, medium or auto (default; currently low for generation, medium for editing). Billed at the quality served.",
  "compatible_models": [
   "grok-imagine-image-2.0"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/images/generation",
  "notes": "Not in the REST reference page nor the OpenAPI GenerateImageRequest (docs-guide only). Live: quality='low' on grok-imagine-image (1.0) was accepted (200, $0.02) rather than rejected.",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "user",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque end-user id for abuse monitoring.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "storage_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Persist the output to the Files API and return `file_output` alongside the ephemeral URL/b64.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "storage_options.filename",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filename for the stored file (required when storage_options is present).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "storage_options.expires_after",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 2592000,
  "enum": null,
  "description": "Seconds until the stored file auto-expires; max 2592000 (30 days); omitted = no expiry.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "storage_options.public_url",
  "location": "body",
  "type": "boolean|object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Also create a permanent shareable public URL (`file_output.public_url`); object form accepts an `expires_after`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/generations",
  "parameter": "aspect_ratio",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1:1",
   "3:4",
   "4:3",
   "9:16",
   "16:9",
   "2:3",
   "3:2",
   "9:19.5",
   "19.5:9",
   "9:20",
   "20:9",
   "1:2",
   "2:1",
   "21:9",
   "5:2",
   "auto"
  ],
  "description": "Aspect ratio; `auto` (default) lets the model pick. 21:9 and 5:2 added 2026-08.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": "Live: '7:7' → 422 text/plain 'Failed to deserialize the JSON body into the target type: aspect_ratio: unknown variant `7:7`, expected one of …'",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "model",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image model id or alias (grok-imagine-image, grok-imagine-image-2.0, grok-imagine-image-quality → served by 2.0/low from 2026-11-02). Effectively required.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": "grok-2-image → 404 not-found (retired slug).",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Prompt (max_prompt_length: 16000 chars on grok-imagine-image / -quality, 64000 on 2.0 per the models endpoint). Required.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "n",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 1,
  "minimum": 1,
  "maximum": 10,
  "enum": null,
  "description": "Number of images (1–10).",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": "Live: n=0 → 400 {code:'invalid-argument', error:'The number of images to generate (n) must be between 1 and 10 inclusive.'}",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "response_format",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "url",
  "minimum": null,
  "maximum": null,
  "enum": [
   "url",
   "b64_json"
  ],
  "description": "`url` (ephemeral hosted URL) or `b64_json` (bare base64, no data-URI prefix).",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": "Live: 'png' → 400 'Invalid format.'",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "resolution",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "1k",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1k",
   "1.5k",
   "2k"
  ],
  "description": "Output resolution; grok-imagine models only. Pricing on 2.0 rises with resolution (1k < 1.5k < 2k).",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/images/generation",
  "notes": "The guide lists only 1k and 2k; the OpenAPI enum and REST reference also include 1.5k (and the 2.0 pricing matrix prices it).",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "quality",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "auto"
  ],
  "description": "Quality tier for grok-imagine-image-2.0: low, medium or auto (default; currently low for generation, medium for editing). Billed at the quality served.",
  "compatible_models": [
   "grok-imagine-image-2.0"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/images/generation",
  "notes": "Not in the REST reference page nor the OpenAPI GenerateImageRequest (docs-guide only). Live: quality='low' on grok-imagine-image (1.0) was accepted (200, $0.02) rather than rejected.",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "user",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque end-user id for abuse monitoring.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "storage_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Persist the output to the Files API and return `file_output` alongside the ephemeral URL/b64.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "storage_options.filename",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filename for the stored file (required when storage_options is present).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "storage_options.expires_after",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 2592000,
  "enum": null,
  "description": "Seconds until the stored file auto-expires; max 2592000 (30 days); omitted = no expiry.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "storage_options.public_url",
  "location": "body",
  "type": "boolean|object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Also create a permanent shareable public URL (`file_output.public_url`); object form accepts an `expires_after`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "aspect_ratio",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "1:1",
   "3:4",
   "4:3",
   "9:16",
   "16:9",
   "2:3",
   "3:2",
   "9:19.5",
   "19.5:9",
   "9:20",
   "20:9",
   "1:2",
   "2:1",
   "21:9",
   "5:2",
   "auto"
  ],
  "description": "Only for multi-image edits (`images`): output ratio, otherwise auto-detected from the first input. Do not set for single-image edits.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "image",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Single source image. Mutually exclusive with `images`.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": "Live quirk: omitting both `image` and `images` does NOT fail — the request behaves like a generation (200, billed $0.02).",
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "image.url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public URL or base64 data URL (JPEG/PNG/WebP). Also accepted as `image_url`. Required when file_id is absent. The docs examples add `type: 'image_url'` (ignored/optional).",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "image.file_id",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files API file id (must be a fully uploaded image). Mutually exclusive with url.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/imagine/files/inputs",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "images",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 5,
  "enum": null,
  "description": "2–5 reference images (was 3 before 2026-08); refer to them as <IMAGE_0>, <IMAGE_1>… in the prompt. Each item {url | file_id}. Mutually exclusive with `image`.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/images/multi-image-editing",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "images[].url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public URL or base64 data URL.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/images/edits",
  "parameter": "images[].file_id",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files API file id.",
  "compatible_models": [
   "grok-imagine-image",
   "grok-imagine-image-2.0",
   "grok-imagine-image-quality"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/images",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/image-generation-models/{model_id}",
  "parameter": "model_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model id or alias.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-images.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "best_of",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Generates multiple completions internally and returns the top-scoring one. Not functional yet.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "echo",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Option to include the original prompt in the response along with the generated completion.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "frequency_penalty",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "logit_bias",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Accepts a JSON object that maps tokens to an associated bias value from -100 to 100. You can use this tokenizer tool to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "logprobs",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to `logprobs+1` elements in the response. Not supported by models `grok-4.20` and newer; the field will be silently ignored if set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "max_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Limits the number of tokens that can be produced in the output. Ensure the sum of prompt tokens and `max_tokens` does not exceed the model's context limit.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Specifies the model to be used for the request.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_note": "2026-09-18: grok-4.3 AND grok-4.20-0309-non-reasoning → 400 'Raw sampling is not supported for reasoning models' — no live model accepts /v1/completions",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "n",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Determines how many completion sequences to produce for each prompt. Be cautious with its use due to high token consumption; adjust `max_tokens` and stop sequences accordingly.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "presence_penalty",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Not supported by `grok-3` and reasoning models) 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "prompt",
  "location": "body",
  "type": "SampleContent",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Input for generating completions, which can be a string, list of strings, token list, or list of token lists. `<|endoftext|>` is used as a document separator, implying a new context start if omitted.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "seed",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": 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. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "stop",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Not supported by reasoning models) Up to 4 sequences where the API will stop generating further tokens.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "stream_options",
  "location": "body",
  "type": "null | StreamOptions",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "stream_options.include_usage",
  "location": "body",
  "type": "boolean",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Set an additional chunk to be streamed before the `data: [DONE]` message. The other chunks will return `null` in `usage` field.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "suffix",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Optional string to append after the generated text.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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. We generally recommend altering this or `top_p` but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "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. We generally recommend altering this or temperature but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/completions",
  "parameter": "user",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "max_tokens_to_sample",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of tokens to generate before stopping.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "metadata",
  "location": "body",
  "type": "null | MessageMetadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "metadata.user_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model to use for completion.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_note": "2026-09-18: both live text models → 400 'Raw sampling is not supported for reasoning models'",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Prompt for the model to perform completion on.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "stop_sequences",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Not supported by reasoning models) Up to 4 sequences where the API will stop generating further tokens.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) If set, partial message deltas 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "top_k",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) When generating next tokens, randomly selecting the next token from the k most likely options.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/complete",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": 1,
  "enum": null,
  "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. It is generally recommended to alter this or `temperature` but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LEGACY",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "dimensions",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The number of dimensions the resulting output embeddings should have.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "encoding_format",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "float",
   "base64"
  ],
  "description": "The format to return the embeddings in. Can be either `float` or `base64`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "input",
  "location": "body",
  "type": "EmbeddingInput",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Input text to embed, encoded as a string or list of tokens. To embed multiple inputs in a single request, pass a list of strings or list of token lists. The total tokens in the input must not exceed the context window for the model and cannot be an empty string. If the input is a list, the maximum length of the list is 128.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "input.String",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A strings to be embedded. For best performance, prepend \"query: \" in front of query content and prepend \"passage: \" in front of passage/text",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "variant": "item=A strings to be embedded",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "input.StringArray",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of strings to be embedded",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "variant": "item=An array of strings to be embedded",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "input.Ints",
  "location": "body",
  "type": "array<integer>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A token in integer to be embedded",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "variant": "item=A token in integer to be embedded",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "input.IntsArray",
  "location": "body",
  "type": "array<array<integer>>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of tokens in integers to be embedded",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "variant": "item=An array of tokens in integers to be embedded",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the model to use.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "live_note": "2026-09-18: GET /v1/embedding-models → {models: []}; POST with grok-embedding-small → 404 not-found 'does not exist or your team does not have access'",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "preview",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Flag to use the new format of the API.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/embeddings",
  "parameter": "user",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tokenize-text",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The model to tokenize with.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: grok-4.3",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tokenize-text",
  "parameter": "text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content to be tokenized.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 'Hello world!' → 3 tokens",
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tokenize-text",
  "parameter": "user",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional user identifier.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/other",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-legacy-completions-embeddings.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "max_tokens",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum number of tokens to generate before stopping. The model may stop before the max_tokens when it reaches the stop sequence.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "format": "int32",
  "live_note": "2026-09-18: 32/64 accepted; output_tokens in usage INCLUDES reasoning tokens (86-181 for 'OK.')",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages",
  "location": "body",
  "type": "array<MessageBody>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Input messages.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_note": "2026-09-18: string content, text/image(url+base64)/tool_use/tool_result/thinking blocks accepted; `document` block → 422",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content",
  "location": "body",
  "type": "MessageContent",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The content message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].cache_control",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Cache control.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=text",
  "live_note": "2026-09-18: cache_control accepted and ignored (spec: unsupported); usage.cache_creation_input_tokens always 0, cache_read_input_tokens reflects automatic prefix cache",
  "live_behavior": "ignored",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text prompt.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=text",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=text",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].cache_control",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Cache control.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=image",
  "live_note": "2026-09-18: cache_control accepted and ignored (spec: unsupported); usage.cache_creation_input_tokens always 0, cache_read_input_tokens reflects automatic prefix cache",
  "live_behavior": "ignored",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source",
  "location": "body",
  "type": "MessageImageContent",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image source.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=image",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Base64 encoded image string.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=base64",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Media type of the image source. Available options: `image/jpeg`, `image/png`, `image/webp`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=base64",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=base64",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "url"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=url",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].source.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URL of the image.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=url",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=image",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].cache_control",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Cache control.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_use",
  "live_note": "2026-09-18: cache_control accepted and ignored (spec: unsupported); usage.cache_creation_input_tokens always 0, cache_read_input_tokens reflects automatic prefix cache",
  "live_behavior": "ignored",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_use",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].input",
  "location": "body",
  "type": "any",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Input for tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_use",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_use",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_use"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_use",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].cache_control",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Cache control.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_result",
  "live_note": "2026-09-18: cache_control accepted and ignored (spec: unsupported); usage.cache_creation_input_tokens always 0, cache_read_input_tokens reflects automatic prefix cache",
  "live_behavior": "ignored",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content",
  "location": "body",
  "type": "ToolResultContent",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Result content of the tool call. Can be a string or an array of content blocks.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_result",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=text",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=text",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content[].source",
  "location": "body",
  "type": "MessageImageContent",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Image source.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=image",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content[].source.data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Base64 encoded image string.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=base64",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content[].source.media_type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Media type of the image source. Available options: `image/jpeg`, `image/png`, `image/webp`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=base64",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "base64"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=base64",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content[].source.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "url"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=url",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content[].source.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "URL of the image.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=url",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=image",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].is_error",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether the tool call returns an error.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_result",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].tool_use_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ID of the tool call given by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_result",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_result"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool_result",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].data",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Encrypted data of the redacted thinking.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=redacted_thinking",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "redacted_thinking"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=redacted_thinking",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].signature",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Signature of the thinking block (required by Anthropic SDK for round-tripping).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=thinking",
  "nullable": true,
  "live_note": "2026-09-18: thinking blocks are returned with signature '' and can be replayed as-is",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].thinking",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Thinking.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=thinking",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "thinking"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=thinking",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "messages[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The role that the message belongs to, `\"system\"` for system prompt, `\"user\"` for user prompt, and `\"assistant\"` for response from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "metadata",
  "location": "body",
  "type": "null | MessageMetadata",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "metadata.user_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "live_note": "2026-09-18: sent with stop_sequences (rejected first); accepted in isolation not re-tested",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model name for the model to use.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_note": "2026-09-18: grok-4.3 and grok-4.20-0309-non-reasoning",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "stop_sequences",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Not supported by reasoning models) Up to 4 sequences where the API will stop generating further tokens.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "live_behavior": "rejected_400_on_reasoning_models",
  "live_note": "2026-09-18: → 400 'Model grok-4.3 does not support parameter stop'",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set, partial message deltas 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "live_note": "2026-09-18: Anthropic SSE events message_start → content_block_start(thinking) → thinking_delta… → content_block_start(text) → text_delta… → message_delta → message_stop",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "system",
  "location": "body",
  "type": "null | SystemMessageContent",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_note": "2026-09-18: string and [{type:text, cache_control}] accepted",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "system[].cache_control",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Cache control.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_note": "2026-09-18: cache_control accepted and ignored (spec: unsupported); usage.cache_creation_input_tokens always 0, cache_read_input_tokens reflects automatic prefix cache",
  "live_behavior": "ignored",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "system[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System prompt text.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "system[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Type of the object. This is always `\"text\"`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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. It may not work well with reasoning models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tool_choice",
  "location": "body",
  "type": "null | MessageToolChoice",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_note": "2026-09-18: {type:'tool', name} forced a tool_use; {type:'auto', disable_parallel_tool_use:true} → 400 schema validation error",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tool_choice.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=auto",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tool_choice.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "any"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=any",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tool_choice.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool to use.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tool_choice.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "variant": "type=tool",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools the model may call in JSON-schema. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 350 functions are supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "live_note": "2026-09-18: Anthropic-shaped {name, description, input_schema} works → tool_use block; `description` is REQUIRED (422 'missing field description'); Anthropic server tools (web_search_20250305) not supported",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].cache_control",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Cache control.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_note": "2026-09-18: cache_control accepted and ignored (spec: unsupported); usage.cache_creation_input_tokens always 0, cache_read_input_tokens reflects automatic prefix cache",
  "live_behavior": "ignored",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Description of the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].input_schema",
  "location": "body",
  "type": "MessageToolInputSchema",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Input schema allowed by the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].input_schema.properties",
  "location": "body",
  "type": "any",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "JSON-object of the tool input schema.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].input_schema.required",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required properties of the tool input schema, if any.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].input_schema.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Type of the schema. This is always `\"object\"`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "top_k",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) When generating next tokens, randomly selecting the next token from the k most likely options.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "int32",
  "live_behavior": "rejected_400",
  "live_note": "2026-09-18: top_k:5 → 400 'Argument not supported: top_k'",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": 1,
  "enum": null,
  "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. It is generally recommended to alter this or `temperature` but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "DEPRECATED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "nullable": true,
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "thinking",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Anthropic `thinking` config. NOT in the xAI spec. Live: {type:'enabled', budget_tokens:1024} accepted silently; no thinking block appeared in the non-streamed text answer (thinking blocks appear when a tool_use is emitted and in streams regardless of this field).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_behavior": "ignored",
  "live_note": "2026-09-18: 200",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "service_tier",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Anthropic field; not in the xAI spec; silently accepted (unknown fields are ignored on /v1/messages).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_behavior": "ignored",
  "live_note": "2026-09-18: 200",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/messages",
  "parameter": "anthropic-version",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Not required by xAI; sending anthropic-version + x-api-key alongside Authorization: Bearer works (200). Auth is Bearer only.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/legacy",
  "live_note": "2026-09-18: 200 with extra Anthropic headers",
  "_fragment": "generated/fragments/parameters/xai-messages-compat.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "background",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "(Unsupported) Whether to process the response asynchronously in the background.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "rejected_400",
  "live_note": "2026-09-18: true → 400 'Argument not supported: background'",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "context_management",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional context-management directives (e.g. compaction). Parsed but not yet executed.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "description_note": "Parsed but not yet executed (spec).",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "include",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "reasoning.encrypted_content",
   "web_search_call.action.sources",
   "code_interpreter_call.outputs",
   "file_search_call.results",
   "no_inline_citations",
   "message.output_text.logprobs (ignored)"
  ],
  "description": "What additional output data to include in the response. Supported values include\n`reasoning.encrypted_content` (encrypted reasoning tokens) and tool-output options.\nOpenAI's `message.output_text.logprobs` is accepted for compatibility but silently ignored.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: reasoning.encrypted_content → reasoning item gains encrypted_content; web_search_call.action.sources, code_interpreter_call.outputs, file_search_call.results accepted; message.output_text.logprobs + no_inline_citations accepted (200)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input",
  "location": "body",
  "type": "ModelInput",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input passed to the model. Can be text, image or file.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: string, message list (system/user/assistant/developer), function_call_output, reasoning item replay (encrypted_content), compaction item, input_image, input_file(file_id)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content",
  "location": "body",
  "type": "ModelInputContent",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image or audio input.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=Message input to the model",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text input.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=output_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "output_text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=output_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "nullable": true,
  "live_note": "2026-09-18: input_image with file_id + empty image_url → 400 'image_url must either be a base64-encoded image or a URL' (file_id path not usable this way)",
  "live_behavior": "rejected_400",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].image_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A public URL of image prompt, only available for vision models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].file_data",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline file bytes (base64 encoded).\n\nWhen set, the file content is provided directly in the request and does NOT need\nto be uploaded to the Files API first.\n\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "live_note": "2026-09-18: only input_file.file_id was exercised (agentic attachment search answered 'PINEAPPLE'); file_url documented in the Chat-with-files guide",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file ID from the Files API.\n\nSet this to reference a previously-uploaded file.\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].file_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public URL for a file attachment.\n\nWhen set, the file content is fetched from this URL.\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "live_note": "2026-09-18: only input_file.file_id was exercised (agentic attachment search answered 'PINEAPPLE'); file_url documented in the Chat-with-files guide",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].filename",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filename for inline uploads.\n\nRequired when `file_data` is set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "live_note": "2026-09-18: only input_file.file_id was exercised (agentic attachment search answered 'PINEAPPLE'); file_url documented in the Chat-with-files guide",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].mime_type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional MIME type for inline uploads (e.g. \"application/pdf\").",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "live_note": "2026-09-18: only input_file.file_id was exercised (agentic attachment search answered 'PINEAPPLE'); file_url documented in the Chat-with-files guide",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_file"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse. Only supported for `user` messages.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=Message input to the model",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The role of the message. Possible values are `user`, `assistant`, `system` and `developer`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=Message input to the model",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the message, which is always `message`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=Message input to the model",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a function tool call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output",
  "location": "body",
  "type": "ModelInputContent",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of the function tool call. Can be a plain string or a list\nof content items (`input_text`, `input_image`, `input_file`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a function tool call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text input.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=output_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "output_text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=output_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].image_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A public URL of image prompt, only available for vision models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].file_data",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline file bytes (base64 encoded).\n\nWhen set, the file content is provided directly in the request and does NOT need\nto be uploaded to the Files API first.\n\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file ID from the Files API.\n\nSet this to reference a previously-uploaded file.\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].file_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public URL for a file attachment.\n\nWhen set, the file content is fetched from this URL.\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].filename",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filename for inline uploads.\n\nRequired when `file_data` is set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].mime_type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional MIME type for inline uploads (e.g. \"application/pdf\").",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_file"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the function tool call, which is always `function_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a function tool call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum length of the shell command output. Generated by the model\nand should be passed back with the raw output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output",
  "location": "body",
  "type": "array<ShellCallOutputResult>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of shell call output contents.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].outcome",
  "location": "body",
  "type": "ShellCallOutcome",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The outcome of the command execution.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].outcome.exit_code",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The exit code of the command.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=exit",
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].outcome.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "exit"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=exit",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].outcome.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "timeout"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=timeout",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].stderr",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The standard error output that was captured.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output[].stdout",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The standard output that was captured.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the output item, which is always `shell_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].encrypted_content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The encrypted content of the compacted conversation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=A compaction item from a previous `/v1/responses/compact` call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the compaction item (e.g. `cmp_<uuid>`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=A compaction item from a previous `/v1/responses/compact` call",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the item. Always `\"compaction\"`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=A compaction item from a previous `/v1/responses/compact` call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "instructions",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An alternate way to specify the system prompt. Note that this cannot be used alongside `previous_response_id`, where the system prompt of the previous message will be used.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: with previous_response_id → 400 'Argument not supported: instructions and previous_response_id together' (as documented)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "logprobs",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": 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. Not supported by models `grok-4.20` and newer; the field will be silently ignored if set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "ignored",
  "live_note": "2026-09-18: accepted, ignored (output_text.logprobs=[]) on grok-4.3",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "max_output_tokens",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max number of tokens that can be generated in a response. This includes both output and reasoning tokens. Defaults to 128,000 when unset; set a larger value to allow longer generations.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "int32",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 32 → 200 status=completed with reasoning_tokens=138 (reasoning not capped by it despite doc); 2000/4000 used elsewhere",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "max_turns",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of agentic tool calling turns allowed for this request.\nIf not set, defaults to the server's global cap.\nThis parameter will be ignored for any non-agentic requests, and for\nagentic SLOP requests that have neither a server-side tool nor a file\nattachment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "int32",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 1-3 accepted on tool requests",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "metadata",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Not supported. Only maintained for compatibility reasons.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "rejected_400",
  "live_note": "2026-09-18: {a:b} → 400 'Argument not supported: metadata'",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "min_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "description": "Min-p sampling: tokens whose probability is below `min_p` times the probability of the most likely token are excluded from sampling. Disabled when unset.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "float",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 0.05 accepted (200)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model name for the model to use. Obtainable from <https://console.x.ai/team/default/models> or <https://docs.x.ai/docs/models>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: grok-4.3, grok-4.20-0309-non-reasoning",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "parallel_tool_calls",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to allow the model to run parallel tool calls.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "previous_response_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ID of the previous response from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: chained 2 turns; echoed in response.previous_response_id",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "prompt_cache_key",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Plumbed to x-grok-conv-id for Open Responses compatibility, used for routing.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 'atlas-key' echoed in response.prompt_cache_key",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning",
  "location": "body",
  "type": "null | ReasoningConfiguration",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: {effort:'low', summary:'detailed'} → echoed; default echo on grok-4.3 is {effort:'low', summary:'detailed'}",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning.effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "low",
   "medium",
   "high",
   "xhigh"
  ],
  "description": "Constrains how hard a reasoning model thinks before responding. Higher efforts use more reasoning tokens for deeper thinking. The supported values and the default depend on the model.",
  "compatible_models": [
   "grok-4.6",
   "grok-4.5",
   "grok-4.3",
   "grok-4.20-0309-reasoning",
   "grok-4.20-multi-agent-0309",
   "grok-build-0.1"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: low accepted",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning.generate_summary",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning.summary",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "auto",
   "concise",
   "detailed"
  ],
  "description": "A summary of the model's reasoning process. Possible values are `auto`, `concise` and `detailed`. Only included for compatibility. The model shall always return `detailed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 'detailed' echoed",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "reasoning_effort",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "reasoning_effort alternative to reasoning configuration. This is a non-standard field meant to ease user experience. We only look at this if the reasoning field is unset.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: top-level alias accepted (200) → response.reasoning.effort='low'",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "safety_identifier",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Supplied by the API client to identify the end user behind this request. A stable string that uniquely identifies each of your users; hash your internal user id or username rather than sending an email or name. Stored with the request metadata so a usage-policy violation can be attributed to that user rather than to the API key.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: accepted; echoed as null in response",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters",
  "location": "body",
  "type": "null | SearchParameters",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_note": "2026-09-18: Live Search retired (410 on chat completions); tools[] web_search/x_search replace it",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.from_date",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Date from which to consider the results in ISO-8601 YYYY-MM-DD. See\n<https://en.wikipedia.org/wiki/ISO_8601>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "date",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.max_search_results",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": 15,
  "minimum": 1,
  "maximum": 30,
  "enum": null,
  "description": "Maximum number of search results to use.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.mode",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Choose the mode to query realtime data:\n* `off`: no search performed and no external will be considered.\n* `on` (default): the model will search in every sources for relevant data.\n* `auto`: the model choose whether to search data or not and where to search the data.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.return_citations",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to return citations in the response or not.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of sources to search in. If no sources specified, the model will look over the web and X by default.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].excluded_x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of X handles to exclude from the search results. X posts returned will not include\nany posts authored by these handles.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].included_x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "NOTE: `included_x_handles` and `x_handles` are the same parameter.\n`included_x_handles` is the new name but we keep both for backward compatibility.\n\nX Handles of the users from whom to consider the posts. Only available if mode is `auto`, `on` or `x`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].post_favorite_count",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The minimum favorite count of the X posts to consider.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].post_view_count",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The minimum view count of the X posts to consider.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "x"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "DEPRECATED in favor of `included_x_handles`. Use `included_x_handles` instead.\nX Handles of the users from whom to consider the posts. Only available if mode is `auto`, `on` or `x`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x",
  "deprecated": true,
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].allowed_websites",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website to allow in the search results. This parameter act as a whitelist\nwhere only those websites can be selected. A maximum of 5 websites can be selected.\n\nNote 1: If no relevant information is found on those websites, the number of results\nreturned might be smaller than `max_search_results`.\n\nNote 2: This parameter cannot be set with `excluded_websites`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ISO alpha-2 code of the country. If the country is set, only data coming from this country\nwill be considered. See <https://en.wikipedia.org/wiki/ISO_3166-2>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web",
  "nullable": true,
  "format": "iso3166-1-alpha-2",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].excluded_websites",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website to exclude from the search results without protocol specification or\nsubdomains. A maximum of 5 websites can be excluded.\n\nNote 2: This parameter cannot be set with `allowed_websites`",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].safe_search",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to true, mature content won't be considered during the search. Default to `true`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "web"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ISO alpha-2 code of the country. If the country is set, only data coming from this country\nwill be considered. See <https://en.wikipedia.org/wiki/ISO_3166-2>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=news",
  "nullable": true,
  "format": "iso3166-1-alpha-2",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].excluded_websites",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website to exclude from the search results without protocol specification or\nsubdomains. A maximum of 5 websites can be excluded.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=news",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].safe_search",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set to true, mature content won't be considered during the search. Default to `true`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=news",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "news"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=news",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].links",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Links of the RSS feeds.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=rss",
  "max_items": 1,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "rss"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=rss",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "search_parameters.to_date",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Date up to which to consider the results in ISO-8601 YYYY-MM-DD. See\n<https://en.wikipedia.org/wiki/ISO_8601>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "RETIRED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "date",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "service_tier",
  "location": "body",
  "type": "null | ServiceTier",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "default",
   "priority"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 'default' accepted",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "store",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Whether to store the input message(s) and model response for later retrieval.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted_but_get_still_200",
  "live_note": "2026-09-18: false → response.store=false; the response is STILL retrievable via GET /v1/responses/{id} (200) — LIVE_DISCOVERED",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "stream",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "If set, partial message deltas 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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: SSE with `event:` lines == data.type; 10 events for a minimal text response",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "temperature",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": 0,
  "maximum": 2,
  "enum": null,
  "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.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "float",
  "live_note": "2026-09-18: default echoed as 0.7 on grok-4.3 (spec default 1)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "text",
  "location": "body",
  "type": "null | ModelResponseConfiguration",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: text.format json_schema (strict) → valid JSON, echoed in response.text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format",
  "location": "body",
  "type": "null | ModelResponseFormat",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text",
   "json_object",
   "json_schema"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: json_schema and text verified",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_object"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=json_object",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format.description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=json_schema",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format.name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=json_schema",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format.schema",
  "location": "body",
  "type": "any",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A json schema representing the desired response schema.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=json_schema",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format.strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=json_schema",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "text.format.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "json_schema"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=json_schema",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice",
  "location": "body",
  "type": "null | ModelToolChoice",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 'none', 'required', {type:'function', name} accepted",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice.name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Name of the function to use.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tool_choice.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Type is always `\"function\"`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A list of tools the model may call in JSON-schema. Currently, only functions and web search are supported as tools. A max of 350 tools are supported.`web_search_preview` tool, if specified, will be overridden by `search_parameters`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "max_items": 350,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: function, web_search, x_search, code_interpreter/code_execution, file_search/collections_search, mcp, image_generation, shell accepted; tool_search → 403 alpha-only; web_search_preview → 422",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].defer_loading",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, the definition is hidden from the model's prompt but stays\ncallable, loaded via a `tool_search` step (`/v1/responses` only).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=function",
  "nullable": true,
  "live_note": "2026-09-18: 403 alpha-only",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of the function to indicate to the model when to call it.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=function",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function. If the model calls the function, this name is used in the\nresponse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=function",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].parameters",
  "location": "body",
  "type": "any",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON schema describing the function parameters. The model _should_ follow the schema,\nhowever, this is not enforced at the moment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=function",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].strict",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Not supported. Only maintained for compatibility reasons.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=function",
  "nullable": true,
  "live_note": "2026-09-18: strict:true accepted silently (spec: not supported, compatibility only)",
  "live_behavior": "ignored",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "function"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=function",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].filters",
  "location": "body",
  "type": "null | WebSearchFilters",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].filters.allowed_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website domains (without protocol specification or subdomains)\nto restrict search results to (e.g., [\"example.com\"]). A maximum of 5 websites can be allowed.\nUse this as a whitelist to limit results to only these specific sites; no other websites will\nbe considered. If no relevant information is found on these websites, the number of results\nreturned might be smaller than `max_search_results` set in `SearchParameters`. Note: This\nparameter cannot be set together with `excluded_domains`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].filters.excluded_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website domains (without protocol specification or subdomains) to exclude from search results (e.g., [\"example.com\"]).\nUse this to prevent results from unwanted sites. A maximum of 5 websites can be excluded.\nThis parameter cannot be set together with `allowed_domains`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].search_context_size",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "High level guidance for the amount of context window space to use for the\nsearch. Available values are `low`, `medium`, or `high`.\nFor OpenAI API compatibility ONLY. Request will be rejected if this field is set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "live_behavior": "rejected_400",
  "live_note": "2026-09-18: search_context_size:'low' → 400 'Argument not supported: search_context_size' (spec: request rejected if set; the RESPONSE echoes search_context_size:'medium' anyway)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].user_location",
  "location": "body",
  "type": "null | WebSearchUserLocation",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "live_behavior": "rejected_400",
  "live_note": "2026-09-18: search_context_size:'low' → 400 'Argument not supported: search_context_size' (spec: request rejected if set; the RESPONSE echoes search_context_size:'medium' anyway)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].user_location.city",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "City of the user's location.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].user_location.country",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Two-letter ISO 3166-1 alpha-2 country code, like US, GB, etc.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].user_location.region",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Region of the user's location.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].user_location.timezone",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Timezone of the user's location, IANA timezone like America/Chicago, Europe/London, etc.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].user_location.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Type is always `\"approximate\"`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].allowed_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website domains to allow in the search results. This parameter act as a whitelist\nwhere only those websites can be selected. A maximum of 5 websites can be selected.\n\nNote: This parameter cannot be set with `excluded_domains`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].enable_image_search",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, activates the image search server-side tool, enabling\nthe model to search for images alongside the standard web search.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].enable_image_understanding",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enable image understanding during web search.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].excluded_domains",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of website domains to exclude from the search results without protocol specification or\nsubdomains. A maximum of 5 websites can be excluded.\n\nNote: This parameter cannot be set with `allowed_domains`",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "max_items": 5,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].external_web_access",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Control whether the web search tool fetches live content or uses only cached content.\nFor OpenAI API compatibility ONLY. Request will be rejected if this field is set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "nullable": true,
  "live_behavior": "rejected_400",
  "live_note": "2026-09-18: search_context_size:'low' → 400 'Argument not supported: search_context_size' (spec: request rejected if set; the RESPONSE echoes search_context_size:'medium' anyway)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "web_search"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=web_search",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].allowed_x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of X Handles of the users from whom to consider the posts.\n\nNote: This parameter cannot be set with `excluded_x_handles`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x_search",
  "nullable": true,
  "max_items": 10,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].enable_image_understanding",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enable image understanding during X search.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x_search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].enable_video_understanding",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enable video understanding during X search.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x_search",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].excluded_x_handles",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of X Handles of the users from whom to exclude the posts.\n\nNote: This parameter cannot be set with `allowed_x_handles`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x_search",
  "nullable": true,
  "max_items": 10,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].from_date",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Date from which to consider the results in ISO-8601 YYYY-MM-DD. See\n<https://en.wikipedia.org/wiki/ISO_8601>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x_search",
  "nullable": true,
  "format": "date",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].to_date",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Date up to which to consider the results in ISO-8601 YYYY-MM-DD. See\n<https://en.wikipedia.org/wiki/ISO_8601>.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x_search",
  "nullable": true,
  "format": "date",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "x_search"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=x_search",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].action",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Which image capabilities to expose to the model. One of `auto`\n(the default; both generation and editing), `generate`\n(text-to-image only), or `edit` (image editing only).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=image_generation",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image_generation"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=image_generation",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].filters",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A filter to apply.\nFor OpenAI API compatibility ONLY. Request will be rejected if this field is set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=file_search",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].max_num_results",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=file_search",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].ranking_options",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Ranking options for search.\nFor OpenAI API compatibility ONLY. Request will be rejected if this field is set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=file_search",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "file_search"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=file_search",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].vector_store_ids",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "List of vector store IDs to search within.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=file_search",
  "max_items": 10,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].container",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The code interpreter container. Can be a container ID or an object that specifies\nuploaded file IDs to make available to your code.\nFor OpenAI API compatibility ONLY. Request will be rejected if this field is set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=code_interpreter",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "code_interpreter"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=code_interpreter",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].allowed_tools",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].authorization",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].connector_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "nullable": true,
  "live_note": "2026-09-18: require_approval:'never' accepted silently (200) — docs say not supported",
  "live_behavior": "ignored",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].defer_loading",
  "location": "body",
  "type": "boolean | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "When true, this server's tool definitions are hidden from the\nmodel's prompt but stay callable, loaded via a `tool_search` step.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "nullable": true,
  "live_note": "2026-09-18: 403 alpha-only",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].headers",
  "location": "body",
  "type": "object | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].require_approval",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "nullable": true,
  "live_note": "2026-09-18: require_approval:'never' accepted silently (200) — docs say not supported",
  "live_behavior": "ignored",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].server_description",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].server_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "mcp"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=mcp",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].environment",
  "location": "body",
  "type": "ShellEnvironment",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The environment configuration for the shell tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=shell",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].environment.skills",
  "location": "body",
  "type": "array<LocalShellSkill>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional list of skills available in the local environment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=shell",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].environment.skills[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of what the skill does.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=shell",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].environment.skills[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the skill.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=shell",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].environment.skills[].path",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The path to the directory containing the skill (with a SKILL.md file).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=shell",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].environment.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the environment. Currently only `local` is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=shell",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "shell"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=shell",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].execution",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Where the search runs. Only `\"server\"` (or unset) is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=tool_search",
  "nullable": true,
  "live_note": "2026-09-18: 403 permission-denied 'The tool_search tool and defer_loading are only available for alpha users'",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "tools[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=tool_search",
  "live_note": "2026-09-18: 403 permission-denied 'The tool_search tool and defer_loading are only available for alpha users'",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "top_k",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 1,
  "maximum": null,
  "enum": null,
  "description": "Top-k sampling: only the `top_k` most probable tokens are considered at each sampling step. Disabled when unset.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "int32",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 40 accepted (200)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "top_logprobs",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 8,
  "enum": null,
  "description": "An integer between 0 and 8 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. Not supported by models `grok-4.20` and newer; the field will be silently ignored if set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "int32",
  "live_behavior": "ignored",
  "live_note": "2026-09-18: accepted, ignored",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "top_p",
  "location": "body",
  "type": "number | null",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": 1,
  "enum": null,
  "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. It is generally recommended to alter this or `temperature` but not both.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "format": "float",
  "live_note": "2026-09-18: default echoed as 0.95 (spec default 1)",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "truncation",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Not supported. Only maintained for compatibility reasons.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_note": "2026-09-18: not isolated (sent with metadata which was rejected); response echoes truncation='disabled'",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "user",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "nullable": true,
  "live_behavior": "accepted",
  "live_note": "2026-09-18: accepted; echoed",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/responses/{response_id}",
  "parameter": "response_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stored response id. 200 ModelResponse; after DELETE → 404.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "DELETE /v1/responses/{response_id}",
  "parameter": "response_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stored response id → {id, object:'response', deleted:true}.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/responses/{response_id}/input_items",
  "parameter": "response_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stored response id.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/responses/{response_id}/input_items",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 20,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Maximum number of items to return (1-100, default 20).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/openapi.json",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/responses/{response_id}/input_items",
  "parameter": "order",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "asc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "Sort order: asc or desc. Default asc.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/openapi.json",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/responses/{response_id}/input_items",
  "parameter": "after",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor for pagination. Returns items after this item ID (ids look like `item_0`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/openapi.json",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input",
  "location": "body",
  "type": "ModelInput",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The full input window to compact.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: 5-message conversation → 1 compaction item, dropped_message_count=3",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content",
  "location": "body",
  "type": "ModelInputContent",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text, image or audio input.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=Message input to the model",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text input.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=output_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "output_text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=output_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].image_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A public URL of image prompt, only available for vision models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].file_data",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline file bytes (base64 encoded).\n\nWhen set, the file content is provided directly in the request and does NOT need\nto be uploaded to the Files API first.\n\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file ID from the Files API.\n\nSet this to reference a previously-uploaded file.\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].file_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public URL for a file attachment.\n\nWhen set, the file content is fetched from this URL.\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].filename",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filename for inline uploads.\n\nRequired when `file_data` is set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].mime_type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional MIME type for inline uploads (e.g. \"application/pdf\").",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_file"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].name",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A unique identifier representing your end-user, which can help xAI to monitor and detect abuse. Only supported for `user` messages.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=Message input to the model",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The role of the message. Possible values are `user`, `assistant`, `system` and `developer`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=Message input to the model",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the message, which is always `message`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=Message input to the model",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a function tool call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output",
  "location": "body",
  "type": "ModelInputContent",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of the function tool call. Can be a plain string or a list\nof content items (`input_text`, `input_image`, `input_file`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a function tool call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Text input.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=output_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "output_text"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=output_text",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Only included for compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].image_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A public URL of image prompt, only available for vision models.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_image"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_image",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].file_data",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Inline file bytes (base64 encoded).\n\nWhen set, the file content is provided directly in the request and does NOT need\nto be uploaded to the Files API first.\n\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].file_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file ID from the Files API.\n\nSet this to reference a previously-uploaded file.\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].file_url",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public URL for a file attachment.\n\nWhen set, the file content is fetched from this URL.\nExactly one of `file_id`, `file_data`, or `file_url` should be set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].filename",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filename for inline uploads.\n\nRequired when `file_data` is set.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].mime_type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional MIME type for inline uploads (e.g. \"application/pdf\").",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "input_file"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=input_file",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the function tool call, which is always `function_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a function tool call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The maximum length of the shell command output. Generated by the model\nand should be passed back with the raw output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output",
  "location": "body",
  "type": "array<ShellCallOutputResult>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of shell call output contents.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].outcome",
  "location": "body",
  "type": "ShellCallOutcome",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The outcome of the command execution.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].outcome.exit_code",
  "location": "body",
  "type": "integer",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The exit code of the command.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=exit",
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].outcome.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "exit"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=exit",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].outcome.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "timeout"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "type=timeout",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].stderr",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The standard error output that was captured.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].output[].stdout",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The standard output that was captured.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the output item, which is always `shell_call_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=The output of a shell tool call, sent by the client after local execut",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].encrypted_content",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The encrypted content of the compacted conversation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=A compaction item from a previous `/v1/responses/compact` call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the compaction item (e.g. `cmp_<uuid>`).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=A compaction item from a previous `/v1/responses/compact` call",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the item. Always `\"compaction\"`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "item=A compaction item from a previous `/v1/responses/compact` call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses/compact",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model to use for compaction summarization (required).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "live_behavior": "accepted",
  "live_note": "2026-09-18: grok-4.3",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content",
  "location": "body",
  "type": "array<OutputMessageContent>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Content of the output message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].annotations",
  "location": "body",
  "type": "array<Annotation>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Citations.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].annotations[].end_index",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The end index of the annotation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].annotations[].start_index",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The summary of the annotation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].annotations[].title",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The title of the annotation.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].annotations[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the annotation. Only supported type currently is `url_citation`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].annotations[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the web resource.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].logprobs",
  "location": "body",
  "type": "array<TokenLogProb>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The log probabilities of each output token returned in the content of message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].logprobs[].bytes",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ASCII encoding of the output character.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].logprobs[].logprob",
  "location": "body",
  "type": "number",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The log probability of returning this token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].logprobs[].token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].logprobs[].top_logprobs",
  "location": "body",
  "type": "array<TopLogProb>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An array of the most likely tokens to return at this token position.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].logprobs[].top_logprobs[].bytes",
  "location": "body",
  "type": "array | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The ASCII encoding of the output character.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].logprobs[].top_logprobs[].logprob",
  "location": "body",
  "type": "number",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The log probability of returning this token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "format": "float",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].logprobs[].top_logprobs[].token",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The token.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text output from the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "refusal"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].refusal",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The reason for the refusal.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the output message.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].role",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The role of the output message, which can be `assistant` or `tool`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Status of the item. One of `completed`, `in_progress` or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the output message, which is always `message`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=message",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The arguments to pass to the function, as a JSON string.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=function_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=function_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=function_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the function.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=function_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Status of the item. One of `completed`, `in_progress` or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=function_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the function tool call, which can be `\"function_call\"` for client-side tool calls,\nand `\"web_search_call\"` or `\"x_search_call\"` or `\"code_interpreter_call\"` or `\"mcp_call\"` for server-side tool calls.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=function_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content",
  "location": "body",
  "type": "array<ReasoningText>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The reasoning text contents.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reasoning done by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].content[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the object, which is always `reasoning_text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].encrypted_content",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The enrypted reasoning. Returned when `reasoning.encrypted_content` is passed in `include`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "nullable": true,
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the reasoning content.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Status of the item. One of `completed`, `in_progress` or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].summary",
  "location": "body",
  "type": "array<SummaryText>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The summarized reasoning text contents.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].summary[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Summary of the reasoning done by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].summary[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the object, which is always `summary_text`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the object, which is always `reasoning`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=reasoning",
  "live_note": "2026-09-18: reasoning item with encrypted_content replayed verbatim → 200",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action",
  "location": "body",
  "type": "WebSearchAction",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An object describing the specific action taken in this web search call.\nIncludes details on how the model used the web (search, open_page, find).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.query",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The search query.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.sources",
  "location": "body",
  "type": "array<WebSearchSource>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The sources used in the search.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.sources[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of source.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.sources[].url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the source.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "find_in_page"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The URL of the page being searched within.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.pattern",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The pattern or text to search for within the page.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the web search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The status of the web search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the web search tool call. Always `web_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=web_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the file search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=file_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].queries",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The queries used to search for files.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=file_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].results",
  "location": "body",
  "type": "array<FileSearchResult>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The results of the file search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=file_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].results[].file_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The file ID of the file search result.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=file_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].results[].filename",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The filename of the file search result.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=file_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].results[].score",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The score of the file search result.\nProto3 omits float fields with value 0.0; default to 0.0 when absent.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=file_search_call",
  "format": "double",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].results[].text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The text of the file search result.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=file_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The status of the file search tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=file_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the file search tool call. Always `file_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=file_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].code",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The code of the code interpreter tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=code_interpreter_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the code interpreter tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=code_interpreter_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].outputs",
  "location": "body",
  "type": "array<CodeInterpreterOutput>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The outputs of the code interpreter tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=code_interpreter_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].outputs[].logs",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of the code interpreter tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=code_interpreter_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].outputs[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image"
  ],
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=code_interpreter_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].outputs[].url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The error of the code interpreter tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=code_interpreter_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The status of the code interpreter tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=code_interpreter_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the code interpreter tool call. Always `code_interpreter_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=code_interpreter_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].arguments",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A JSON string of the arguments passed to the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=mcp_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].error",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The error message of the MCP tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=mcp_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the MCP tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=mcp_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the tool that was run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=mcp_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].output",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The output of the MCP tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=mcp_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].server_label",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The label of the MCP server running the tool.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=mcp_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The status of the MCP tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=mcp_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the MCP tool call. Always `mcp_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=mcp_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the function tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=custom_tool_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The status of the custom tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=custom_tool_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].input",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the custom tool call,",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=custom_tool_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An identifier used to map this custom tool call to a tool call output.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=custom_tool_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Status of the item. One of `completed`, `in_progress` or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=custom_tool_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The input for the custom tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=custom_tool_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action",
  "location": "body",
  "type": "ShellCallAction",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The shell commands and limits that describe how to run the tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.commands",
  "location": "body",
  "type": "array<string>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The commands to run.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.max_output_length",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional maximum number of characters to return from each command.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "nullable": true,
  "format": "int32",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.timeout_ms",
  "location": "body",
  "type": "integer | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional timeout in milliseconds for the commands.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "nullable": true,
  "format": "int64",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].action.type",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the action, which is always `exec`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].call_id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell tool call generated by the model.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].environment",
  "location": "body",
  "type": "null | ShellEnvironment",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": null,
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].environment.skills",
  "location": "body",
  "type": "array<LocalShellSkill>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "An optional list of skills available in the local environment.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].environment.skills[].description",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "A description of what the skill does.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].environment.skills[].name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The name of the skill.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].environment.skills[].path",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The path to the directory containing the skill (with a SKILL.md file).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].environment.type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the environment. Currently only `local` is supported.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the shell call item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Status of the item. One of `completed`, `in_progress` or `incomplete`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The type of the output item, which is always `shell_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=shell_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the image generation tool call.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=image_generation_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].prompt",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The prompt used to generate the image.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=image_generation_call",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].result",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The generated image encoded in base64 (OpenAI-compatible: bare\nbase64, no data-URL prefix), or `null` while the call is still in\nprogress or has failed. The image format can be determined from the\ndecoded magic bytes (typically JPEG or PNG).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=image_generation_call",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The status of the image generation tool call. One of `in_progress`,\n`generating`, `completed` or `failed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=image_generation_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "image_generation_call"
  ],
  "description": "The type of the image generation tool call. Always `image_generation_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=image_generation_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].arguments",
  "location": "body",
  "type": "any",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The arguments of the tool search call: `{\"query\": ..., \"limit\": ...}`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Always `null`; present for OpenAI compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_call",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Where the search runs. Always `server`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool search call item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Status of the item. One of `in_progress`, `completed` or\n`incomplete` (a failed search).",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_call"
  ],
  "description": "The type of the item. Always `tool_search_call`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_call",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].call_id",
  "location": "body",
  "type": "string | null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Always `null`; present for OpenAI compatibility.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_output",
  "nullable": true,
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].execution",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Where the search ran. Always `server`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_output",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].id",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The unique ID of the tool search output item.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_output",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].status",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Status of the item. Always `completed`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_output",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].tools",
  "location": "body",
  "type": "array<any>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "The loaded tool definitions, echoed in the shape they were supplied in.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_output",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses",
  "parameter": "input[].type",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "tool_search_output"
  ],
  "description": "The type of the item. Always `tool_search_output`.",
  "compatible_models": [
   "*"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/responses",
  "variant": "replayed output item type=tool_search_output",
  "_fragment": "generated/fragments/parameters/xai-responses.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/skills",
  "parameter": "limit",
  "location": "query",
  "type": "integer|null",
  "required": false,
  "default": 100,
  "minimum": 1,
  "maximum": 100,
  "enum": null,
  "description": "Page size 1–100.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": "Live 404 with our key.",
  "_fragment": "generated/fragments/parameters/xai-skills.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/skills",
  "parameter": "after",
  "location": "query",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cursor: id of the last item of the previous page.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-skills.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/skills",
  "parameter": "order",
  "location": "query",
  "type": "string|null",
  "required": false,
  "default": "desc",
  "minimum": null,
  "maximum": null,
  "enum": [
   "asc",
   "desc"
  ],
  "description": "asc | desc.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-skills.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/skills",
  "parameter": "files",
  "location": "body",
  "type": "array<binary>",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skill zip, or the field repeated once per file of a directory upload. SKILL.md frontmatter (name, description) is parsed server-side.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": "Live: zip and single-file uploads both → 404 text/plain.",
  "_fragment": "generated/fragments/parameters/xai-skills.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/skills/{skill_id}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skill id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-skills.json"
 },
 {
  "provider": "xai",
  "endpoint": "DELETE /v1/skills/{skill_id}",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skill id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-skills.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/skills/{skill_id}/content",
  "parameter": "skill_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skill id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "ACCOUNT_RESTRICTED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-skills.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/responses (tools[] shell.environment)",
  "parameter": "environment.skills[]",
  "location": "body",
  "type": "array<LocalShellSkill>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Skills available in a local shell environment: {name, description, path (directory with SKILL.md)}. `environment.type` is 'local'. This is the only place the OpenAPI wires skills into inference (ShellCall.environment).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-skills.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "model",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "grok-imagine-video ($0.05/s; text/image/video inputs) or grok-imagine-video-1.5 ($0.08/s; text/image/audio inputs, native 1080p, reference audio, last_frame).",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Required for text-to-video; optional when `image`, `reference_images` or `last_frame` is present.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "duration",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 8,
  "minimum": 1,
  "maximum": 15,
  "enum": null,
  "description": "Output length in seconds, 1–15 (also accepts `seconds` and string values for OpenAI compatibility).",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": "Live: duration 1 accepted (billed 1 s); 99 → 400 'Duration must be between 1 and 15 seconds'.",
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "aspect_ratio",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "16:9",
  "minimum": null,
  "maximum": null,
  "enum": [
   "1:1",
   "16:9",
   "9:16",
   "4:3",
   "3:4",
   "3:2",
   "2:3"
  ],
  "description": "Ignored for image-to-video (derived from the first frame — guide says it can override and stretch).",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "resolution",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": "480p",
  "minimum": null,
  "maximum": null,
  "enum": [
   "480p",
   "720p",
   "1080p"
  ],
  "description": "480p (default, fastest), 720p, 1080p (grok-imagine-video-1.5 T2V/I2V only; reference-to-video capped at 720p).",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": "Live: '4k' → 422 text/plain serde error listing the enum.",
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "image",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "First-frame image for image-to-video ({url | file_id}; also `input_reference`). With reference_images/reference_audios/last_frame on 1.5 it pins the first frame.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "image.url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public URL or base64 data URL (JPEG/PNG/WebP). Also `image_url`.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "image.file_id",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files API file id.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "reference_images",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reference-to-video: style/content references ({url | file_id}), tagged <IMAGE_0>… in the prompt.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/video/reference-to-video",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "reference_audios",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 3,
  "enum": null,
  "description": "Up to 3 voice references ({voice_id} preset from GET /v1/tts/voices, or {url} clip ≤ 15 s — own-clip uploads are trusted-partner only). Tag <AUDIO_0>… in the prompt. grok-imagine-video-1.5 only.",
  "compatible_models": [
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/video/reference-to-video",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "reference_audios[].voice_id",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Preset voice id (case-insensitive); unknown → 400 with the list of voices.",
  "compatible_models": [
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/video/reference-to-video",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "reference_audios[].url",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "data:audio/wav;base64,… or http(s) clip ≤ 15 s (trusted partners).",
  "compatible_models": [
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/video/reference-to-video",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "last_frame",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Pin the exact last frame ({url | file_id}); alone or with `image` (first frame → interpolation). grok-imagine-video-1.5 only; classic grok-imagine-video rejects it.",
  "compatible_models": [
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/video/generation",
  "notes": "Documented in the guide's Request Modes table, absent from the REST reference/OpenAPI.",
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "generate_audio",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Videos include an audio track by default; false → silent video.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/video/generation",
  "notes": "Guide-only parameter (not in REST reference/OpenAPI).",
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "output",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Bring-your-own storage: {upload_url} presigned URL the service PUTs the MP4 to (used by Grok Build under ZDR).",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "output.upload_url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Signed URL for HTTP PUT of the generated video.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "user",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque end-user id.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "storage_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Persist the output to the Files API and return `file_output` alongside the ephemeral URL/b64.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "storage_options.filename",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filename for the stored file (required when storage_options is present).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "storage_options.expires_after",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 2592000,
  "enum": null,
  "description": "Seconds until the stored file auto-expires; max 2592000 (30 days); omitted = no expiry.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/generations",
  "parameter": "storage_options.public_url",
  "location": "body",
  "type": "boolean|object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Also create a permanent shareable public URL (`file_output.public_url`); object form accepts an `expires_after`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "model",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Video model (docs examples use grok-imagine-video).",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Edit instruction.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "video",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Source video {url | file_id}; .mp4 (H.264/H.265/AV1…), ≤ 8.7 s, output capped at 720p.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": "Live: missing → 422 text/plain 'missing field `video`'.",
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "video.url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Public .mp4 URL or base64 data URL.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "video.file_id",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Files API file id (video).",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "output",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{upload_url} presigned PUT target.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "user",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Opaque end-user id.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "storage_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Persist the output to the Files API and return `file_output` alongside the ephemeral URL/b64.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "storage_options.filename",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filename for the stored file (required when storage_options is present).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "storage_options.expires_after",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 2592000,
  "enum": null,
  "description": "Seconds until the stored file auto-expires; max 2592000 (30 days); omitted = no expiry.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/edits",
  "parameter": "storage_options.public_url",
  "location": "body",
  "type": "boolean|object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Also create a permanent shareable public URL (`file_output.public_url`); object form accepts an `expires_after`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "model",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Video model.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "prompt",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "What happens next.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "video",
  "location": "body",
  "type": "object",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Source video {url | file_id}.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "duration",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 6,
  "minimum": 2,
  "maximum": 10,
  "enum": null,
  "description": "Length of the ADDED segment in seconds (2–10); total output = original + extension.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "output",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "{upload_url} presigned PUT target.",
  "compatible_models": [
   "grok-imagine-video",
   "grok-imagine-video-1.5"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "storage_options",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Persist the output to the Files API and return `file_output` alongside the ephemeral URL/b64.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "storage_options.filename",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Filename for the stored file (required when storage_options is present).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "storage_options.expires_after",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 2592000,
  "enum": null,
  "description": "Seconds until the stored file auto-expires; max 2592000 (30 days); omitted = no expiry.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/videos/extensions",
  "parameter": "storage_options.public_url",
  "location": "body",
  "type": "boolean|object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Also create a permanent shareable public URL (`file_output.public_url`); object form accepts an `expires_after`.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/videos/{request_id}",
  "parameter": "request_id",
  "location": "path",
  "type": "string (UUID)",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Deferred request id from a generations/edits/extensions call.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/videos",
  "notes": "Live: non-UUID → 400 'Malformed request ID'; unknown UUID → 404 'Failed to read static file.'",
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/video-generation-models/{model_id}",
  "parameter": "model_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Model id or alias.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/openapi.json (local copy sources/xai/openapi/openapi.json)",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-videos.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "expires_after.seconds",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 600,
  "minimum": null,
  "maximum": 3600,
  "enum": null,
  "description": "TTL of the secret; max 3600; default 600.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Initial session config stored with the secret and applied when the WebSocket opens.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": "The ephemeral-tokens guide says 'session' and 'expires_after.anchor' are not supported; the REST reference documents `session` and it was accepted live (200).",
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "grok-voice-latest",
   "grok-voice-think-fast-2.0"
  ],
  "description": "Voice model bound to the secret.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/realtime/client_secrets",
  "parameter": "session.reasoning.effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "high",
  "minimum": null,
  "maximum": null,
  "enum": [
   "high",
   "none"
  ],
  "description": "high (default) or none.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime",
  "parameter": "model",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "grok-voice-latest",
  "minimum": null,
  "maximum": null,
  "enum": [
   "grok-voice-latest",
   "grok-voice-think-fast-2.0"
  ],
  "description": "Voice model; ignored with call_id.",
  "compatible_models": [
   "grok-voice-latest",
   "grok-voice-think-fast-2.0"
  ],
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime",
  "parameter": "reasoning.effort",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "high",
  "minimum": null,
  "maximum": null,
  "enum": [
   "high",
   "none"
  ],
  "description": "Enable/disable reasoning for the session.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime",
  "parameter": "call_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SIP call id from a realtime.call.incoming webhook; binds the socket to that call (API key auth only).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime",
  "parameter": "conversation_id",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Resume a cached conversation (requires session.resumption.enabled on both sessions; 30 min inactivity expiry).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime",
  "parameter": "Authorization",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Bearer <api key> (server) or Bearer <ephemeral secret>.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime",
  "parameter": "Sec-WebSocket-Protocol",
  "location": "header",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Browser auth: `xai-client-secret.<ephemeral token>`; replaces the Authorization header.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "grok-voice-latest",
   "grok-voice-think-fast-2.0"
  ],
  "description": "Model (also settable by query).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/voice-realtime.ws.json",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "System prompt (second person, fixed section order recommended).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.reasoning.effort",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "high",
  "minimum": null,
  "maximum": null,
  "enum": [
   "high",
   "none"
  ],
  "description": "high (default) or none.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.voice",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "xai_ara (observed in session.created; docs say eve)",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Built-in voice id (GET /v1/tts/voices) or 8-char custom voice id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.turn_detection.type",
  "location": "body",
  "type": "string|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "server_vad",
   null
  ],
  "description": "`server_vad` (auto turns) or null (manual: commit + response.create).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.turn_detection.threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 0.85,
  "minimum": 0.1,
  "maximum": 0.9,
  "enum": null,
  "description": "VAD activation threshold 0.1–0.9.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.turn_detection.silence_duration_ms",
  "location": "body",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": 0,
  "maximum": 10000,
  "enum": null,
  "description": "Silence before the turn ends (0–10000).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.turn_detection.prefix_padding_ms",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 333,
  "minimum": 0,
  "maximum": 10000,
  "enum": null,
  "description": "Audio kept before detected speech start (0–10000).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.turn_detection.idle_timeout_ms",
  "location": "body",
  "type": "number|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Proactive re-engagement timer after each response (emits input_audio_buffer.timeout_triggered).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.resumption.enabled",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Cache turns keyed by conversation_id for replay on reconnect (xAI extension).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.input.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "audio/pcm",
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma",
   "audio/opus"
  ],
  "description": "Input codec.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.input.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 24000,
  "minimum": null,
  "maximum": null,
  "enum": [
   8000,
   11025,
   16000,
   22050,
   24000,
   32000,
   44100,
   48000
  ],
  "description": "PCM sample rate (Hz).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": "11025 appears only in the ws.json schema enum, not in the guide table.",
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.input.transport",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "json",
  "minimum": null,
  "maximum": null,
  "enum": [
   "json",
   "binary"
  ],
  "description": "json (base64 in input_audio_buffer.append) or binary (raw frames; dual-accept).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.input.transcription.language_hint",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "BCP-47 hint for ASR (es/pt need a regional variant).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.input.transcription.keyterms",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 100,
  "enum": null,
  "description": "≤ 100 terms, ≤ 50 chars each.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.input.transcription.model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "grok-transcribe"
  ],
  "description": "Set to `grok-transcribe` to receive conversation.item.input_audio_transcription.updated events (live captions).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.output.format.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "audio/pcm",
  "minimum": null,
  "maximum": null,
  "enum": [
   "audio/pcm",
   "audio/pcmu",
   "audio/pcma",
   "audio/opus"
  ],
  "description": "Output codec.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.output.format.rate",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": 24000,
  "minimum": null,
  "maximum": null,
  "enum": [
   8000,
   11025,
   16000,
   22050,
   24000,
   32000,
   44100,
   48000
  ],
  "description": "PCM sample rate (Hz).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.output.transport",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "json",
  "minimum": null,
  "maximum": null,
  "enum": [
   "json",
   "binary"
  ],
  "description": "json or binary; strict (output only on the configured path); changes apply at the next response boundary.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.audio.output.speed",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1.0,
  "minimum": 0.7,
  "maximum": 1.5,
  "enum": null,
  "description": "Playback speed 0.7–1.5.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.replace",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Phrase → spoken substitution map applied before TTS (transcript unchanged); echoed on session.updated.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.tools",
  "location": "body",
  "type": "array<object>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "file_search {vector_store_ids, max_num_results} · web_search {allowed_domains|excluded_domains ≤5, enable_image_understanding, location} · x_search {allowed_x_handles|excluded_x_handles ≤20, from_date, to_date, enable_image_understanding, enable_video_understanding} · mcp {server_url, server_label, server_description, allowed_tools, authorization, headers} · function {name, description, parameters}.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": "Server-side tools are executed by xAI; only `function` requires client handling via function_call_output.",
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.tool_choice",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "auto",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Observed in session.updated ('auto'); not documented.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "tmp-live/xai-media/voice-ws-session.json",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.enable_noise_suppression",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Observed in session.updated (false); not documented.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "tmp-live/xai-media/voice-ws-session.json",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.enable_phonetic_spelling",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Observed in session.updated (false); not documented.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "tmp-live/xai-media/voice-ws-session.json",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.keep_context",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Observed in session.updated (false); not documented.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "tmp-live/xai-media/voice-ws-session.json",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.temperature",
  "location": "body",
  "type": "number",
  "required": false,
  "default": -1.0,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Observed in session.updated as -1.0 (unset); not documented.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "tmp-live/xai-media/voice-ws-session.json",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime session.update",
  "parameter": "session.max_response_output_tokens",
  "location": "body",
  "type": "string|integer",
  "required": false,
  "default": "inf",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Observed in session.updated as 'inf'; not documented.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "LIVE_DISCOVERED"
  ],
  "source": "tmp-live/xai-media/voice-ws-session.json",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime response.create",
  "parameter": "response.instructions",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Per-response override of the session system prompt.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime response.create",
  "parameter": "response.metadata",
  "location": "body",
  "type": "object|null",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Developer key-values echoed on response.done (schema).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/voice-realtime.ws.json",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime conversation.item.create",
  "parameter": "item.type",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "message",
   "function_call",
   "function_call_output",
   "force_message"
  ],
  "description": "message (user/assistant, content input_text|input_audio|output_text) · function_call (seed history) · function_call_output {call_id, output} · force_message (xAI: verbatim TTS line, {role:'assistant', interruptible, content:[{type:'output_text', text}]}).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/realtime conversation.item.create",
  "parameter": "item.interruptible",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": true,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "force_message only: false drops caller audio until playback completes.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/speech-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "text",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": 60000,
  "enum": null,
  "description": "≤ 60,000 chars; speech tags [pause] [laugh] … and wrappers <whisper> <soft> …",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "voice_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "eve",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Built-in (GET /v1/tts/voices) or custom voice id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "language",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "BCP-47 (en, zh, pt-BR…) or auto. REQUIRED.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": "Live: missing → 422 text/plain 'missing field `language`'.",
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "output_format.codec",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "mp3",
  "minimum": null,
  "maximum": null,
  "enum": [
   "mp3",
   "wav",
   "pcm",
   "mulaw",
   "alaw"
  ],
  "description": "Audio codec.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "output_format.sample_rate",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 24000,
  "minimum": null,
  "maximum": null,
  "enum": [
   8000,
   16000,
   22050,
   24000,
   44100,
   48000
  ],
  "description": "Hz.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "output_format.bit_rate",
  "location": "body",
  "type": "integer|null",
  "required": false,
  "default": 128000,
  "minimum": null,
  "maximum": null,
  "enum": [
   32000,
   64000,
   96000,
   128000,
   192000
  ],
  "description": "bps, mp3 only.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "speed",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 1.0,
  "minimum": 0.7,
  "maximum": 1.5,
  "enum": null,
  "description": "0.7–1.5.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "optimize_streaming_latency",
  "location": "body",
  "type": "string|integer",
  "required": false,
  "default": "0",
  "minimum": null,
  "maximum": null,
  "enum": [
   "0",
   "1",
   "2"
  ],
  "description": "0 (quality) | 1 (smaller first chunk); the guide also lists 2.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "text_normalization",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Expand numbers/abbreviations to spoken form.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "with_timestamps",
  "location": "body",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "true → JSON envelope with per-character timings (adds latency).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/tts",
  "parameter": "replace",
  "location": "body",
  "type": "object",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 200,
  "enum": null,
  "description": "Phrase → respelling or /IPA/ map; ≤ 200 entries, keys ≤ 100 chars (letters/digits/apostrophes/spaces), values ≤ 128; expanded text ≤ 240,000 chars.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/text-to-speech",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/tts",
  "parameter": "voice",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "eve",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Voice id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/tts",
  "parameter": "language",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "BCP-47 or auto (required).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/tts",
  "parameter": "codec",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "mp3",
  "minimum": null,
  "maximum": null,
  "enum": [
   "mp3",
   "wav",
   "pcm",
   "mulaw",
   "alaw"
  ],
  "description": "Output codec.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/tts",
  "parameter": "sample_rate",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 24000,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Hz.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/tts",
  "parameter": "bit_rate",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 128000,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "bps (mp3).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/tts",
  "parameter": "optimize_streaming_latency",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 0,
  "minimum": null,
  "maximum": null,
  "enum": [
   0,
   1
  ],
  "description": "0 or 1.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/tts",
  "parameter": "speed",
  "location": "query",
  "type": "number",
  "required": false,
  "default": 1.0,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "0.7–1.5.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/tts",
  "parameter": "text_normalization",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Normalize text.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/tts",
  "parameter": "with_timestamps",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "audio_timestamps on each audio.delta.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "file",
  "location": "body",
  "type": "binary",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Audio ≤ 500 MB; must be the LAST multipart field. Either file or url.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Server-side download URL (alternative to file).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "audio_format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "pcm",
   "mulaw",
   "alaw",
   "wav",
   "mp3",
   "ogg",
   "opus",
   "flac",
   "aac",
   "mp4",
   "m4a",
   "mkv"
  ],
  "description": "Only for raw formats.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "sample_rate",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "8000",
   "16000",
   "22050",
   "24000",
   "44100",
   "48000"
  ],
  "description": "Required for raw formats (also sample_rate_hertz).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Language code; with format=true enables inverse text normalization.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "format",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": [
   "true",
   "false"
  ],
  "description": "'true' enables formatting (requires language).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "multichannel",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": [
   "true",
   "false"
  ],
  "description": "Per-channel transcription → channels[].",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "channels",
  "location": "body",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": 2,
  "maximum": 8,
  "enum": null,
  "description": "2–8, required for multichannel raw audio.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "diarize",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": [
   "true",
   "false"
  ],
  "description": "Speaker diarization → words[].speaker.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "keyterm",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": 100,
  "enum": null,
  "description": "Repeatable bias terms, ≤ 100 × 50 chars.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "filler_words",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "false",
  "minimum": null,
  "maximum": null,
  "enum": [
   "true",
   "false"
  ],
  "description": "Keep uh/um.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "vad_threshold",
  "location": "body",
  "type": "number",
  "required": false,
  "default": 0.5,
  "minimum": 0,
  "maximum": 1,
  "enum": null,
  "description": "Speech-probability gate 0–1; 0 disables.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/stt",
  "parameter": "model",
  "location": "body",
  "type": "string",
  "required": false,
  "default": "grok-voice-transcribe-2.0",
  "minimum": null,
  "maximum": null,
  "enum": [
   "grok-voice-transcribe-1.0",
   "grok-voice-transcribe-2.0"
  ],
  "description": "grok-voice-transcribe-1.0 | 2.0 (default 2.0 per the guide; the REST page does not list it for batch).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/model-capabilities/audio/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "sample_rate",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 16000,
  "minimum": null,
  "maximum": null,
  "enum": [
   8000,
   16000,
   22050,
   24000,
   44100,
   48000
  ],
  "description": "Hz (ignored for opus).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "encoding",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "pcm",
  "minimum": null,
  "maximum": null,
  "enum": [
   "pcm",
   "mulaw",
   "alaw",
   "opus"
  ],
  "description": "pcm s16le | mulaw | alaw | opus (one packet per binary frame, mono).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "interim_results",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Emit is_final=false partials ~every 500 ms.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "endpointing",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 400,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Silence ms before speech_final (0–5000).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "language",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "",
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Enables inverse text normalization.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "model",
  "location": "query",
  "type": "string",
  "required": false,
  "default": "grok-voice-transcribe-2.0",
  "minimum": null,
  "maximum": null,
  "enum": [
   "grok-voice-transcribe-1.0",
   "grok-voice-transcribe-2.0"
  ],
  "description": "Transcribe model.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "multichannel",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Requires channels ≥ 2; not with opus.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "channels",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 1,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "1–8.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "diarize",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Speaker field on words.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "keyterm",
  "location": "query",
  "type": "string (repeatable)",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Bias terms.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "filler_words",
  "location": "query",
  "type": "boolean",
  "required": false,
  "default": false,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Keep fillers.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "smart_turn",
  "location": "query",
  "type": "number",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "End-of-turn confidence threshold 0–1 (adds end_of_turn_confidence to partials).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "smart_turn_timeout",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Max silence ms before forced speech_final (1–5000).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "WS wss://api.x.ai/v1/stt",
  "parameter": "vad_threshold",
  "location": "query",
  "type": "number",
  "required": false,
  "default": 0.08,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Speech gate 0–1.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/custom-voices",
  "parameter": "file",
  "location": "body",
  "type": "binary",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Reference clip ≤ 120 s (90–120 s recommended).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/custom-voices",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Display name.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/custom-voices",
  "parameter": "description",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free text.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/custom-voices",
  "parameter": "gender",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "male",
   "female",
   "neutral"
  ],
  "description": "Label.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/custom-voices",
  "parameter": "accent",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Free text.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/custom-voices",
  "parameter": "age",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "young",
   "middle-aged",
   "old"
  ],
  "description": "Label.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/custom-voices",
  "parameter": "language",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "ISO 639 / BCP-47 (region uppercase).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/custom-voices",
  "parameter": "use_case",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "conversational",
   "narration",
   "characters",
   "educational",
   "advertisement",
   "social_media",
   "entertainment"
  ],
  "description": "Label.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/custom-voices",
  "parameter": "tone",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "warm",
   "casual",
   "professional",
   "friendly",
   "authoritative",
   "expressive",
   "calm"
  ],
  "description": "Label.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/custom-voices",
  "parameter": "limit",
  "location": "query",
  "type": "integer",
  "required": false,
  "default": 100,
  "minimum": 1,
  "maximum": 1000,
  "enum": null,
  "description": "1–1000.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED",
   "LIVE_VERIFIED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/custom-voices",
  "parameter": "pagination_token",
  "location": "query",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Next-page token from the previous response.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "GET /v1/custom-voices/{voice_id}",
  "parameter": "voice_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "8-char lowercase alphanumeric id.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "origin",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": [
   "xai_provisioned",
   "byo_trunk"
  ],
  "description": "byo_trunk for customer-owned Direct SIP numbers; xai_provisioned not available via API per the SIP guide.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "name",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Display name.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "agent_id",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Route to an agent (mutually exclusive with webhook).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "phone_number",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "E.164 number (byo_trunk).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "area_code",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "3-digit US area code filter (xai_provisioned).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "sip_auth.auth_username",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "SIP digest username (with auth_password).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "sip_auth.auth_password",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Stored encrypted, never returned.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "sip_auth.allowed_addresses",
  "location": "body",
  "type": "array<string>",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Source CIDRs allowed to INVITE.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "webhook.url",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Receives signed realtime.call.incoming POSTs.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "webhook.name",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Optional display name.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "webhook.auth_url",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "OAuth token-exchange URL (with auth_token).",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v2/phone-numbers",
  "parameter": "webhook.auth_token",
  "location": "body",
  "type": "string",
  "required": false,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "Bearer credential or OAuth client credential.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/refer",
  "parameter": "call_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "From realtime.call.incoming.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/refer",
  "parameter": "target_uri",
  "location": "body",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "tel:+E.164 or sip:user@host.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 },
 {
  "provider": "xai",
  "endpoint": "POST /v1/realtime/calls/{call_id}/hangup",
  "parameter": "call_id",
  "location": "path",
  "type": "string",
  "required": true,
  "default": null,
  "minimum": null,
  "maximum": null,
  "enum": null,
  "description": "From realtime.call.incoming.",
  "compatible_models": null,
  "beta_header": null,
  "status": [
   "DOCUMENTED"
  ],
  "source": "https://docs.x.ai/developers/rest-api-reference/inference/voice",
  "notes": null,
  "_fragment": "generated/fragments/parameters/xai-voice.json"
 }
]