diff --git a/.spectral-baseline.json b/.spectral-baseline.json index 943b706..233b461 100644 --- a/.spectral-baseline.json +++ b/.spectral-baseline.json @@ -3,7 +3,7 @@ "counts": { "array-items": 4, "no-$ref-siblings": 64, - "operation-operationId": 45, + "operation-operationId": 48, "operation-success-response": 1 } } diff --git a/README.md b/README.md index 79b35a5..0365ad8 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ empty, and it would have cost the whole gate the day one was written. The four decision files under `_project/` are the same idea applied to structure. Each holds a decision that would otherwise be spread across the document — sixty-odd -`servers` blocks, eleven tag groups' worth of operations, 187 page URLs — where +`servers` blocks, eleven tag groups' worth of operations, 203 page URLs — where it can be read, reviewed and changed in one place. `scripts/build.py` applies them back onto `openapi.yaml` and CI fails if the document and the decisions disagree. @@ -62,12 +62,12 @@ disagree. | | | |---|---| | OpenAPI | 3.0.0 | -| Paths / operations | 121 / 187 | -| Components | 480, of which 442 schemas | -| Tags | 42, across 6 navigation groups | +| Paths / operations | 131 / 203 | +| Components | 521, of which 479 schemas | +| Tags | 46, across 6 navigation groups | | Servers | 5 hosts across 4 planes — managed and self-hosted gateway, control plane, admin, admin-in-path | | Security | 1 scheme: `Authorization: Bearer` | -| Docs URLs | 187 — one `x-mint.href` per operation, all unique | +| Docs URLs | 203 — one `x-mint.href` per operation, all unique | | Prose fields stripped | 4,221 | | Written descriptions | 0 — blocked on KB access | @@ -157,7 +157,7 @@ changing either is a migration rather than a spec edit.** ``` `{tag-path}` is the tag kebab-cased, with `>` becoming a path separator, and -`{operation-slug}` is the `operationId` kebab-cased. The **45 operations with no +`{operation-slug}` is the `operationId` kebab-cased. The **48 operations with no `operationId` get a slug from their method and path** — `by-id` for a `{id}` segment — and *not* an `operationId`. The distinction is why this could be done while Phase 2 waits: an `operationId` is a contract key that SDK generators turn @@ -266,11 +266,11 @@ shrink, never grow. What is in there today: | Count | Rule | What it is | |---|---|---| | 64 | `no-$ref-siblings` | `title`, `nullable`, `type` and `x-oaiExpandable` beside a `$ref`, which OpenAPI 3.0 silently ignores | -| 45 | `operation-operationId` | The known gap | +| 48 | `operation-operationId` | The known gap. 45 inherited; 3 more with the analytics groups ported on 2026-11-02, which have none upstream either | | 4 | `array-items` | Arrays with no `items` | | 1 | `operation-success-response` | `GET /realtime` declares no 2xx | -114 findings across 4 rules, down from 193 across 6 before the drops. +117 findings across 4 rules, down from 193 across 6 before the drops. `oas3-unused-component` went from 26 to **0**: the drop pruned every component nothing reaches, including 52 the base was already carrying unreferenced. @@ -310,7 +310,7 @@ domain and not subordinate to the KB (recorded exemption, Q6, 2026-09-07). The reconciliation loop is therefore three-node — KB ↔ spec ↔ docs — and drift from *either* side is a defect, with no authoritative side to fall back on. -`x-airs-provenance` is scaffolded on all 187 operations with `claims` empty. It +`x-airs-provenance` is scaffolded on all 203 operations with `claims` empty. It is not only "which claim supports this description"; it is the **join key that makes drift detectable**. Without a claim reference on an operation, nothing can tell that the KB moved and the spec did not. @@ -503,6 +503,17 @@ about files that still decide things: does `openapi.yaml` agree with `tags-map.yaml`? The base is gone; the decisions taken against it are still enforced. +Closed means nothing *follows* Portkey automatically, not that nothing may be +taken from it. Changes are ported one at a time, as decisions, structure only: +`POST /decisions` from Portkey-AI/openapi#160 (2026-09-29), and on 2026-11-02 +everything upstream merged up to `adfd74b` — the Anthropic integration and its +WIF/OAuth auth, integration tags, the deployment and workspace analytics +filters, three analytics groups, Egress Allowlist (admin), Access Policies +(control plane), the Anthropic Messages API (gateway), and the +`createThreadMessage` rename. Each carries its source commit in its commit +message and, in `_project/planes.yaml`, in its `how`. What came over is +Portkey's shape, as unverified against the Prisma AIRS API as the rest. + The strip itself was recorded in `PROSE-INVENTORY.csv` — a pointer, length and SHA-256 digest per field, never the text. It was frozen at the end of Phase 1, because it could only be derived by diffing against the base, and removed on @@ -521,7 +532,7 @@ wanted. reachable from this workspace. The left-hand column of the inherit/re-ground split is *machine-verifiable in principle* — send a request, compare the response — and that verification has not been done. -- **45 operations have no `operationId`** (listed in `build-report.txt`). An +- **48 operations have no `operationId`** (listed in `build-report.txt`). An inherited gap. Inventing identifiers is not the same as recovering them, so they are reported for engineering rather than filled in. This also blocks SDK generation: Stainless, Speakeasy and Fern all derive method names from it. @@ -535,7 +546,7 @@ wanted. - **No code samples.** Mintlify generates one per operation from the schema, and it dumps every property: `POST /chat/completions` renders all 24, `seed` and `logit_bias` included, because Mintlify does not use `required` to trim the - example. Hand-written cURL samples for all 187 operations are Phase 3 work. + example. Hand-written cURL samples for all 203 operations are Phase 3 work. Until then the generated sample is correct but verbose. cURL only is the intended end state — a single `x-codeSamples` entry suppresses the other language tabs, and other languages are a separate decision. @@ -546,12 +557,39 @@ wanted. For the three `PUT`s, requiring nothing may already be correct, since a partial update where every field is optional is a normal design. Wants engineering. -- **114 lint findings are baselined**, all inherited. See the linting section. +- **117 lint findings are baselined**, all inherited or carried in with ported + structure. See the linting section. +- **Lint fails on `path-params`**, and has since PR #3 (2026-09-18). + `POST /api-keys/{sub-type}` and `/api-keys/{id}` are the same template to + OpenAPI, which forbids that. It is not baselined, because it is a defect in + the URL design rather than inherited debt: either the create path changes or + the two are merged into one path item. Wants an API decision. - **One operation is documented as needing no credentials** — `GET /model-configs/pricing/{provider}/{model}`, which the base declared with `security: []`. Preserved rather than quietly reversed: making it require auth is as much an unverified claim as leaving it public. `scripts/check.py` prints - it on every run. Wants engineering. + it on every run. Since 2026-11-02 it also requires `workspace_id`, which sits + oddly with taking no credentials: either it needs auth after all or it should + not need a workspace. Wants engineering. +- **`workspace_id` is required on 80 operations, decided but not verified.** + Vrushank, 2026-11-02: `WorkspaceIdQuery` is mandatory and a uuid wherever it + appears, including every analytics operation and all of `/api-keys`, and the + analytics `include_all_workspaces` and `exclude_workspace_slugs` filters must + keep working beside it. oasdiff grades the 76 that existed before as 86 + breaking changes; the four ported since are new. The version + stays `3.0.0` because no SDK has been generated from the document. Nobody has + yet sent a request to confirm it. Three things a live call against the + control plane (SCM token, `tsg_id` scope) would settle: + - a request with no `workspace_id` is rejected + - `include_all_workspaces=true` widens beyond the one required workspace, + rather than being refused or ignored + - `exclude_workspace_slugs` removes a workspace from those results + + One tension to settle with it: PR #3 took the scope out of the API key create + path because the scope comes from the calling token, the same reasoning that + removed `organisation_id`. If a workspace-scoped token already carries its + workspace, `workspace_id` may only be needed, and required, for org-level + tokens. - **`organisation_id` is gone as a parameter but survives as a response field.** Engineering's instruction was scoped to parameters, and it was followed to that scope. Fifteen component schemas still carry an diff --git a/_project/hrefs.yaml b/_project/hrefs.yaml index 96199e1..5d3d40b 100644 --- a/_project/hrefs.yaml +++ b/_project/hrefs.yaml @@ -212,4 +212,20 @@ hrefs: PUT /deployments/{deploymentId}: /aigw/api-reference/deployments/update-deployment DELETE /deployments/{deploymentId}: /aigw/api-reference/deployments/delete-deployment GET /deployments/{deploymentId}/ping: /aigw/api-reference/deployments/ping-deployment -pinned: [] + GET /analytics/groups/a2a: /aigw/api-reference/analytics/groups/get-analytics-groups-a2a + GET /analytics/groups/mcp: /aigw/api-reference/analytics/groups/get-analytics-groups-mcp + GET /analytics/groups/workspaces: /aigw/api-reference/analytics/groups/get-analytics-groups-workspaces + GET /egress-allowlist: /aigw/api-reference/egress-allowlist/list-egress-allowlist + POST /egress-allowlist: /aigw/api-reference/egress-allowlist/create-egress-allowlist-entry + GET /egress-allowlist/{egressAllowlistId}: /aigw/api-reference/egress-allowlist/get-egress-allowlist-entry + PUT /egress-allowlist/{egressAllowlistId}: /aigw/api-reference/egress-allowlist/update-egress-allowlist-entry + DELETE /egress-allowlist/{egressAllowlistId}: /aigw/api-reference/egress-allowlist/delete-egress-allowlist-entry + POST /policies/access: /aigw/api-reference/access-policies/create-access-policy + GET /policies/access: /aigw/api-reference/access-policies/list-access-policies + GET /policies/access/{accessPolicyId}: /aigw/api-reference/access-policies/get-access-policy + PUT /policies/access/{accessPolicyId}: /aigw/api-reference/access-policies/update-access-policy + DELETE /policies/access/{accessPolicyId}: /aigw/api-reference/access-policies/delete-access-policy + POST /messages: /aigw/api-reference/messages/create-message + POST /messages/count_tokens: /aigw/api-reference/messages/count-message-tokens +pinned: +- POST /threads/{thread_id}/messages diff --git a/_project/planes.yaml b/_project/planes.yaml index 2075552..db0d912 100644 --- a/_project/planes.yaml +++ b/_project/planes.yaml @@ -28,6 +28,10 @@ # (Integrations, MCP Integrations, Secret References, # Org Guardrails, Deployments) and written out here # as the paths those capabilities cover +# vrushank.2026-11-02 -- ported from Portkey-AI/openapi after the base +# linkage closed (upstream commits up to adfd74b); +# the plane was decided by Vrushank, not read off +# Portkey's server overrides # Tags whose operations are deliberately not all on one plane. `check.py` fails # on any other tag that spans two, because the split was decided by capability @@ -60,6 +64,9 @@ control-plane: "/analytics/groups/ai-models": inherited "/analytics/groups/metadata/{metadataKey}": inherited "/analytics/groups/provider": inherited + "/analytics/groups/a2a": vrushank.2026-11-02 + "/analytics/groups/mcp": vrushank.2026-11-02 + "/analytics/groups/workspaces": vrushank.2026-11-02 "/analytics/groups/users": inherited "/analytics/summary/cache": inherited "/api-keys": inherited @@ -83,6 +90,9 @@ control-plane: "/mcp-servers/{mcpServerId}/user-access": inherited "/model-configs/pricing/{provider}/{model}": classification.yaml "/models/{model}": classification.yaml + # Ported from Portkey-AI/openapi 2bc08ce and 700ece6 (Vrushank, 2026-11-02). + "/policies/access": vrushank.2026-11-02 + "/policies/access/{accessPolicyId}": vrushank.2026-11-02 "/policies/rate-limits": classification.yaml "/policies/rate-limits/{rateLimitsPolicyId}": classification.yaml "/policies/usage-limits": classification.yaml @@ -117,6 +127,10 @@ admin: "/deployments/{deploymentId}": vrushank.2026-09-15 "/deployments/{deploymentId}/ping": vrushank.2026-09-15 + # Ported from Portkey-AI/openapi 8f91369. An admin API (Vrushank, 2026-11-02). + "/egress-allowlist": vrushank.2026-11-02 + "/egress-allowlist/{egressAllowlistId}": vrushank.2026-11-02 + # The org-level guardrails, which the API serves at the same suffix as the # control-plane ones. The `/admin/v2` in these keys is the server prefix, moved # here because a document cannot hold two paths spelled `/guardrails`. @@ -140,6 +154,9 @@ gateway: "/completions": inherited "/decisions": portkey-openapi#160 "/embeddings": inherited + # Anthropic Messages API, ported from Portkey-AI/openapi 9283142 and 6ac6e5d. + "/messages": vrushank.2026-11-02 + "/messages/count_tokens": vrushank.2026-11-02 "/files": inherited "/files/{file_id}": inherited "/files/{file_id}/content": inherited diff --git a/build-report.txt b/build-report.txt index 224924c..5a16067 100644 --- a/build-report.txt +++ b/build-report.txt @@ -1,33 +1,33 @@ Generated by scripts/build.py from openapi.yaml. -operations 188 -paths 122 -schemas 446 -tags 43 +operations 203 +paths 131 +schemas 479 +tags 46 -docs URLs 188 +docs URLs 203 x-mint.href on every operation, from _project/hrefs.yaml. These are public URLs: the build re-derives each one and fails if it has moved, because a tag rename changes them silently and links point at them. -prose 0 written of 420 fields +prose 0 written of 453 fields Authored in overlays/docs-prose.yaml under the grounding gate and merged into openapi.yaml by this script. Every prose field here is stripped and reapplied on each build, so nothing reaches the published document without passing that gate. -servers 1 root + 69 path override(s) +servers 1 root + 76 path override(s) Every URL comes from _project/servers.yaml; which plane a path is on comes from _project/planes.yaml. Edit a host there and rebuild. The first entry in a plane is the one Mintlify builds its sample from; the rest appear in its base-URL dropdown. The gateway is the root block, so its paths carry no override. - gateway 53 path(s) + gateway 55 path(s) https://aigw.portkey.ai/v1 -- Managed https://self-hosted-gateway-url.example.com/v1 -- Self-hosted -- replace with your own gateway host - control-plane 51 path(s) + control-plane 56 path(s) https://api.apps.paloaltonetworks.com/ai_gw/v2 -- Managed - admin 14 path(s) + admin 16 path(s) https://api.apps.paloaltonetworks.com/ai_gw/admin/v2 -- Managed admin-in-path 4 path(s) https://api.apps.paloaltonetworks.com/ai_gw -- Managed @@ -48,7 +48,7 @@ components pruned this run 0 null defaults dropped this run 0 -operations lacking operationId 45 +operations lacking operationId 48 Inherited gaps, not introduced here. operationId values are never renamed, and inventing them is not the same as recovering them, so they are reported for engineering rather than filled in. Phase 2. @@ -73,10 +73,13 @@ operations lacking operationId 45 GET /analytics/graphs/tokens GET /analytics/graphs/users GET /analytics/graphs/users/requests + GET /analytics/groups/a2a GET /analytics/groups/ai-models + GET /analytics/groups/mcp GET /analytics/groups/metadata/{metadataKey} GET /analytics/groups/provider GET /analytics/groups/users + GET /analytics/groups/workspaces GET /analytics/summary/cache GET /api-keys GET /api-keys/{id} diff --git a/docs-navigation.json b/docs-navigation.json index 871d26c..1db9b30 100644 --- a/docs-navigation.json +++ b/docs-navigation.json @@ -142,6 +142,17 @@ "POST /images/variations" ] }, + { + "group": "Messages", + "openapi": { + "source": "https://raw.githubusercontent.com/PaloAltoNetworks/openapi/refs/heads/main/openapi.yaml", + "directory": "api-reference" + }, + "pages": [ + "POST /messages", + "POST /messages/count_tokens" + ] + }, { "group": "Model Pricing", "openapi": { @@ -465,6 +476,20 @@ "POST /api-keys/{id}/rotate" ] }, + { + "group": "Access Policies", + "openapi": { + "source": "https://raw.githubusercontent.com/PaloAltoNetworks/openapi/refs/heads/main/openapi.yaml", + "directory": "api-reference" + }, + "pages": [ + "POST /policies/access", + "GET /policies/access", + "GET /policies/access/{accessPolicyId}", + "PUT /policies/access/{accessPolicyId}", + "DELETE /policies/access/{accessPolicyId}" + ] + }, { "group": "Deployments", "openapi": { @@ -480,6 +505,20 @@ "GET /deployments/{deploymentId}/ping" ] }, + { + "group": "Egress Allowlist", + "openapi": { + "source": "https://raw.githubusercontent.com/PaloAltoNetworks/openapi/refs/heads/main/openapi.yaml", + "directory": "api-reference" + }, + "pages": [ + "GET /egress-allowlist", + "POST /egress-allowlist", + "GET /egress-allowlist/{egressAllowlistId}", + "PUT /egress-allowlist/{egressAllowlistId}", + "DELETE /egress-allowlist/{egressAllowlistId}" + ] + }, { "group": "Org Guardrails", "openapi": { @@ -568,7 +607,10 @@ "GET /analytics/groups/users", "GET /analytics/groups/ai-models", "GET /analytics/groups/provider", - "GET /analytics/groups/metadata/{metadataKey}" + "GET /analytics/groups/metadata/{metadataKey}", + "GET /analytics/groups/a2a", + "GET /analytics/groups/mcp", + "GET /analytics/groups/workspaces" ] }, { diff --git a/openapi.yaml b/openapi.yaml index 3b5180c..2a1de0f 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -41,6 +41,8 @@ tags: description: '' - name: Images description: '' +- name: Messages + description: '' - name: Model Pricing description: '' - name: Models @@ -89,8 +91,12 @@ tags: description: '' - name: API Keys description: '' +- name: Access Policies + description: '' - name: Deployments description: '' +- name: Egress Allowlist + description: '' - name: Org Guardrails description: '' - name: Rate Limit Policies @@ -243,16 +249,14 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/guardrails/create-guardrail + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' get: operationId: listGuardrails tags: - Guardrails parameters: - - name: workspace_id - in: query - schema: - type: string - format: uuid + - $ref: '#/components/parameters/WorkspaceIdQuery' - name: page_size in: query schema: @@ -307,6 +311,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -344,6 +349,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' requestBody: required: true content: @@ -387,6 +393,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -469,6 +476,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/guardrails/bulk-sync-guardrail-mcp-servers + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' get: operationId: listGuardrailMcpServers tags: @@ -508,6 +517,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/guardrails/list-guardrail-mcp-servers + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 description: Managed @@ -573,6 +584,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/guardrails/upsert-guardrail-mcp-server + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 description: Managed @@ -1625,6 +1638,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -1650,6 +1664,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -2139,7 +2154,7 @@ paths: x-mint: href: /aigw/api-reference/assistants/list-messages post: - operationId: createMessage + operationId: createThreadMessage tags: - Assistants parameters: @@ -3245,6 +3260,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/configs/list-configs + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' post: tags: - Configs @@ -3290,6 +3307,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/configs/create-config + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 description: Managed @@ -3304,6 +3323,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -3329,6 +3349,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -3393,6 +3414,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' requestBody: required: true content: @@ -3447,6 +3469,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -3539,6 +3562,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/feedback/create-feedback + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 description: Managed @@ -3552,6 +3577,7 @@ paths: schema: type: string format: uuid + - $ref: '#/components/parameters/WorkspaceIdQuery' tags: - Feedback requestBody: @@ -3604,6 +3630,11 @@ paths: - organisation - all default: all + - in: query + name: tags + schema: + type: string + description: '' responses: '200': description: '' @@ -3903,10 +3934,7 @@ paths: name: page_size schema: type: integer - - in: query - name: workspace_id - schema: - type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -3985,6 +4013,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/providers/post-providers + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 description: Managed @@ -3993,10 +4023,7 @@ paths: tags: - Providers parameters: - - in: query - name: workspace_id - schema: - type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' - in: path name: slug schema: @@ -4021,10 +4048,7 @@ paths: tags: - Providers parameters: - - in: query - name: workspace_id - schema: - type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' - in: path name: slug schema: @@ -4077,10 +4101,7 @@ paths: tags: - Providers parameters: - - in: query - name: workspace_id - schema: - type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' - in: path name: slug schema: @@ -4447,15 +4468,14 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/mcp-servers/mcp-servers-create + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' get: operationId: McpServers_list tags: - MCP Servers parameters: - - name: workspace_id - in: query - schema: - type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' - name: current_page in: query schema: @@ -4522,6 +4542,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/mcp-servers/mcp-servers-retrieve + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' put: operationId: McpServers_update tags: @@ -4546,6 +4568,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/mcp-servers/mcp-servers-update + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' delete: operationId: McpServers_delete tags: @@ -4565,6 +4589,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/mcp-servers/mcp-servers-delete + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 description: Managed @@ -4594,6 +4620,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/mcp-servers/mcp-servers-test + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 description: Managed @@ -4631,6 +4659,7 @@ paths: - prompt - resource - resource_template + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -4671,6 +4700,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/mcp-servers/capabilities/mcp-server-capabilities-bulk-update + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 description: Managed @@ -4703,6 +4734,7 @@ paths: in: query schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -4742,6 +4774,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/mcp-servers/user-access/mcp-server-user-access-bulk-update + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 description: Managed @@ -4761,10 +4795,7 @@ paths: in: query schema: type: string - - name: workspace_id - in: query - schema: - type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' - name: current_page in: query schema: @@ -4803,10 +4834,7 @@ paths: schema: type: string format: uuid - - name: workspace_id - in: query - schema: - type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -4910,6 +4938,7 @@ paths: - user - service required: true + - $ref: '#/components/parameters/WorkspaceIdQuery' requestBody: content: application/json: @@ -4960,10 +4989,7 @@ paths: in: query schema: type: integer - - name: workspace_id - in: query - schema: - type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5002,6 +5028,7 @@ paths: type: string format: uuid required: true + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5031,6 +5058,7 @@ paths: type: string format: uuid required: true + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5060,6 +5088,7 @@ paths: type: string format: uuid required: true + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5098,6 +5127,7 @@ paths: type: string format: uuid required: true + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5156,6 +5186,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/usage-limit-policies/create-usage-limits-policy + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' get: tags: - Usage Limit Policies @@ -5231,6 +5263,7 @@ paths: schema: type: boolean default: false + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5262,6 +5295,7 @@ paths: operationId: updateUsageLimitsPolicy parameters: - $ref: '#/components/parameters/PolicyUsageLimitsId' + - $ref: '#/components/parameters/WorkspaceIdQuery' requestBody: required: true content: @@ -5303,6 +5337,7 @@ paths: operationId: deleteUsageLimitsPolicy parameters: - $ref: '#/components/parameters/PolicyUsageLimitsId' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5363,6 +5398,7 @@ paths: minimum: 1 maximum: 100 - $ref: '#/components/parameters/CurrentPage' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5399,6 +5435,7 @@ paths: parameters: - $ref: '#/components/parameters/PolicyUsageLimitsId' - $ref: '#/components/parameters/UsageLimitsPolicyEntityId' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5461,6 +5498,8 @@ paths: text_digest: '' x-mint: href: /aigw/api-reference/rate-limit-policies/create-rate-limits-policy + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' get: tags: - Rate Limit Policies @@ -5548,6 +5587,7 @@ paths: - active - archived default: active + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5579,6 +5619,7 @@ paths: operationId: updateRateLimitsPolicy parameters: - $ref: '#/components/parameters/RateLimitsPolicyId' + - $ref: '#/components/parameters/WorkspaceIdQuery' requestBody: required: true content: @@ -5620,6 +5661,7 @@ paths: operationId: deleteRateLimitsPolicy parameters: - $ref: '#/components/parameters/RateLimitsPolicyId' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5658,6 +5700,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -5676,9 +5720,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5736,6 +5782,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -5754,9 +5802,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5820,6 +5870,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -5838,9 +5890,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -5916,6 +5970,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -5934,9 +5990,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6000,6 +6058,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6018,9 +6078,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6078,6 +6140,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6096,9 +6160,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6162,6 +6228,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6180,9 +6248,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6240,6 +6310,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6258,9 +6330,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6318,6 +6392,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6336,9 +6412,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6418,12 +6496,16 @@ paths: - $ref: '#/components/parameters/VirtualKeys' - $ref: '#/components/parameters/Configs' - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6483,6 +6565,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6501,9 +6585,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6574,6 +6660,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6592,9 +6680,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6667,6 +6757,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6685,9 +6777,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6740,6 +6834,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6758,9 +6854,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6818,6 +6916,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6836,9 +6936,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6895,6 +6997,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6913,9 +7017,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -6973,6 +7079,8 @@ paths: - Analytics > Graphs parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -6991,9 +7099,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -7048,6 +7158,8 @@ paths: - Analytics > Summary parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -7066,9 +7178,11 @@ paths: - $ref: '#/components/parameters/ApiKeyIds' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -7116,6 +7230,8 @@ paths: - Analytics > Groups parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -7136,9 +7252,11 @@ paths: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -7193,6 +7311,8 @@ paths: - Analytics > Groups parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -7213,9 +7333,11 @@ paths: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -7268,6 +7390,8 @@ paths: - Analytics > Groups parameters: - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -7288,6 +7412,7 @@ paths: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/OrderBy' - $ref: '#/components/parameters/OrderByType' - name: columns @@ -7302,6 +7427,7 @@ paths: - 'true' - 'false' default: 'true' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -7354,6 +7480,8 @@ paths: type: string required: true - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/IncludeAllWorkspaces' + - $ref: '#/components/parameters/ExcludeWorkspaceSlugs' - $ref: '#/components/parameters/TimeOfGenerationMin' - $ref: '#/components/parameters/TimeOfGenerationMax' - $ref: '#/components/parameters/TotalUnitsMin' @@ -7374,9 +7502,11 @@ paths: - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Metadata' - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' - $ref: '#/components/parameters/TraceId' - $ref: '#/components/parameters/SpanId' - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -7451,6 +7581,7 @@ paths: required: true schema: type: string + - $ref: '#/components/parameters/WorkspaceIdQuery' responses: '200': description: '' @@ -7912,125 +8043,889 @@ paths: servers: - url: https://api.apps.paloaltonetworks.com/ai_gw/admin/v2 description: Managed -components: - securitySchemes: - Authorization: - type: http - scheme: bearer - parameters: - TimeOfGenerationMin: - in: query - name: time_of_generation_min - required: true - schema: - type: string - format: date-time - TimeOfGenerationMax: - in: query - name: time_of_generation_max - required: true - schema: - type: string - format: date-time - TotalUnitsMin: - in: query - name: total_units_min - schema: - type: integer - minimum: 0 - TotalUnitsMax: - in: query - name: total_units_max - schema: - type: integer - minimum: 0 - CostMin: - in: query - name: cost_min - schema: - type: number - minimum: 0 - CostMax: - in: query - name: cost_max - schema: - type: number - minimum: 0 - PromptTokenMin: - in: query - name: prompt_token_min - schema: - type: integer - minimum: 0 - PromptTokenMax: - in: query - name: prompt_token_max - schema: - type: integer - minimum: 0 - CompletionTokenMin: - in: query - name: completion_token_min - schema: - type: integer - minimum: 0 - CompletionTokenMax: - in: query - name: completion_token_max - schema: - type: integer - minimum: 0 - StatusCode: - in: query - name: status_code - schema: - type: string - PageSize: - in: query - name: page_size - schema: - type: integer - minimum: 0 - CurrentPage: - in: query - name: current_page - schema: - type: integer - minimum: 0 - WeightedFeedbackMin: - in: query - name: weighted_feedback_min - schema: - type: number - minimum: -10 - maximum: 10 - WeightedFeedbackMax: - in: query - name: weighted_feedback_max - schema: - type: number - minimum: -10 - maximum: 10 - OrderBy: - in: query - name: order_by - schema: - type: string - OrderByType: - in: query - name: order_by_type - schema: - type: string - VirtualKeys: - in: query - name: virtual_keys - schema: - type: string - Configs: - in: query - name: configs - schema: - type: string + /analytics/groups/a2a: + get: + tags: + - Analytics > Groups + summary: '' + parameters: + - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/TimeOfGenerationMin' + - $ref: '#/components/parameters/TimeOfGenerationMax' + - $ref: '#/components/parameters/TotalUnitsMin' + - $ref: '#/components/parameters/TotalUnitsMax' + - $ref: '#/components/parameters/CostMin' + - $ref: '#/components/parameters/CostMax' + - $ref: '#/components/parameters/PromptTokenMin' + - $ref: '#/components/parameters/PromptTokenMax' + - $ref: '#/components/parameters/CompletionTokenMin' + - $ref: '#/components/parameters/CompletionTokenMax' + - $ref: '#/components/parameters/StatusCode' + - $ref: '#/components/parameters/WeightedFeedbackMin' + - $ref: '#/components/parameters/WeightedFeedbackMax' + - $ref: '#/components/parameters/VirtualKeys' + - $ref: '#/components/parameters/Configs' + - $ref: '#/components/parameters/ApiKeyIds' + - $ref: '#/components/parameters/CurrentPage' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Metadata' + - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' + - $ref: '#/components/parameters/TraceId' + - $ref: '#/components/parameters/SpanId' + - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' + responses: + '200': + description: '' + headers: + Content-Type: + schema: + type: string + content: + application/json: + schema: + type: object + properties: + object: + type: string + enum: + - list + total: + type: integer + description: '' + data: + type: array + items: + type: object + properties: + name: + type: string + description: '' + requests: + type: integer + description: '' + object: + type: string + description: '' + enum: + - analytics-group + required: + - object + - data + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/analytics/groups/get-analytics-groups-a2a + servers: + - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 + description: Managed + /analytics/groups/mcp: + get: + tags: + - Analytics > Groups + summary: '' + parameters: + - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/TimeOfGenerationMin' + - $ref: '#/components/parameters/TimeOfGenerationMax' + - $ref: '#/components/parameters/TotalUnitsMin' + - $ref: '#/components/parameters/TotalUnitsMax' + - $ref: '#/components/parameters/CostMin' + - $ref: '#/components/parameters/CostMax' + - $ref: '#/components/parameters/PromptTokenMin' + - $ref: '#/components/parameters/PromptTokenMax' + - $ref: '#/components/parameters/CompletionTokenMin' + - $ref: '#/components/parameters/CompletionTokenMax' + - $ref: '#/components/parameters/StatusCode' + - $ref: '#/components/parameters/WeightedFeedbackMin' + - $ref: '#/components/parameters/WeightedFeedbackMax' + - $ref: '#/components/parameters/VirtualKeys' + - $ref: '#/components/parameters/Configs' + - $ref: '#/components/parameters/ApiKeyIds' + - $ref: '#/components/parameters/CurrentPage' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Metadata' + - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' + - $ref: '#/components/parameters/TraceId' + - $ref: '#/components/parameters/SpanId' + - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' + responses: + '200': + description: '' + headers: + Content-Type: + schema: + type: string + content: + application/json: + schema: + type: object + properties: + object: + type: string + enum: + - list + total: + type: integer + description: '' + data: + type: array + items: + type: object + properties: + name: + type: string + description: '' + requests: + type: integer + description: '' + object: + type: string + description: '' + enum: + - analytics-group + required: + - object + - data + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/analytics/groups/get-analytics-groups-mcp + servers: + - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 + description: Managed + /analytics/groups/workspaces: + get: + tags: + - Analytics > Groups + summary: '' + parameters: + - $ref: '#/components/parameters/WorkspaceSlug' + - $ref: '#/components/parameters/TimeOfGenerationMin' + - $ref: '#/components/parameters/TimeOfGenerationMax' + - $ref: '#/components/parameters/TotalUnitsMin' + - $ref: '#/components/parameters/TotalUnitsMax' + - $ref: '#/components/parameters/CostMin' + - $ref: '#/components/parameters/CostMax' + - $ref: '#/components/parameters/PromptTokenMin' + - $ref: '#/components/parameters/PromptTokenMax' + - $ref: '#/components/parameters/CompletionTokenMin' + - $ref: '#/components/parameters/CompletionTokenMax' + - $ref: '#/components/parameters/StatusCode' + - $ref: '#/components/parameters/WeightedFeedbackMin' + - $ref: '#/components/parameters/WeightedFeedbackMax' + - $ref: '#/components/parameters/VirtualKeys' + - $ref: '#/components/parameters/Configs' + - $ref: '#/components/parameters/ApiKeyIds' + - $ref: '#/components/parameters/CurrentPage' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Metadata' + - $ref: '#/components/parameters/AiOrgModel' + - $ref: '#/components/parameters/DeploymentId' + - $ref: '#/components/parameters/TraceId' + - $ref: '#/components/parameters/SpanId' + - $ref: '#/components/parameters/PromptSlug' + - $ref: '#/components/parameters/WorkspaceIdQuery' + responses: + '200': + description: '' + headers: + Content-Type: + schema: + type: string + content: + application/json: + schema: + type: object + properties: + object: + type: string + enum: + - list + total: + type: integer + description: '' + is_quota_exceeded: + type: boolean + description: '' + data: + type: array + items: + type: object + properties: + workspace_slug: + type: string + description: '' + requests: + type: integer + description: '' + cost: + type: number + description: '' + object: + type: string + description: '' + enum: + - analytics-group + required: + - object + - data + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/analytics/groups/get-analytics-groups-workspaces + servers: + - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 + description: Managed + /egress-allowlist: + get: + operationId: listEgressAllowlist + summary: '' + tags: + - Egress Allowlist + parameters: + - in: query + name: search + schema: + type: string + minLength: 1 + maxLength: 255 + description: '' + - in: query + name: current_page + schema: + type: integer + minimum: 0 + default: 0 + description: '' + - in: query + name: page_size + schema: + type: integer + minimum: 1 + maximum: 100 + default: 20 + description: '' + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object: + type: string + enum: + - list + total: + type: integer + data: + type: array + items: + $ref: '#/components/schemas/EgressAllowlistEntry' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/egress-allowlist/list-egress-allowlist + post: + operationId: createEgressAllowlistEntry + summary: '' + tags: + - Egress Allowlist + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateEgressAllowlistRequest' + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: uuid + domain: + type: string + description: '' + object: + type: string + enum: + - egress-allowlist + '400': + description: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/egress-allowlist/create-egress-allowlist-entry + servers: + - url: https://api.apps.paloaltonetworks.com/ai_gw/admin/v2 + description: Managed + /egress-allowlist/{egressAllowlistId}: + get: + operationId: getEgressAllowlistEntry + summary: '' + tags: + - Egress Allowlist + parameters: + - in: path + name: egressAllowlistId + required: true + schema: + type: string + format: uuid + description: '' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/EgressAllowlistEntry' + '404': + description: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/egress-allowlist/get-egress-allowlist-entry + put: + operationId: updateEgressAllowlistEntry + summary: '' + tags: + - Egress Allowlist + parameters: + - in: path + name: egressAllowlistId + required: true + schema: + type: string + format: uuid + description: '' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateEgressAllowlistRequest' + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + '400': + description: '' + '404': + description: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/egress-allowlist/update-egress-allowlist-entry + delete: + operationId: deleteEgressAllowlistEntry + summary: '' + tags: + - Egress Allowlist + parameters: + - in: path + name: egressAllowlistId + required: true + schema: + type: string + format: uuid + description: '' + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + '404': + description: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/egress-allowlist/delete-egress-allowlist-entry + servers: + - url: https://api.apps.paloaltonetworks.com/ai_gw/admin/v2 + description: Managed + /policies/access: + post: + tags: + - Access Policies + summary: '' + description: '' + operationId: createAccessPolicy + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAccessPolicyRequest' + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + id: + type: string + format: uuid + object: + type: string + enum: + - access + '400': + description: '' + '401': + description: '' + '403': + description: '' + '404': + description: '' + '409': + description: '' + '500': + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/access-policies/create-access-policy + get: + tags: + - Access Policies + summary: '' + description: '' + operationId: listAccessPolicies + parameters: + - $ref: '#/components/parameters/WorkspaceIdQuery' + - name: effect + in: query + description: '' + required: false + schema: + type: string + enum: + - allow + - deny + - name: enabled + in: query + description: '' + required: false + schema: + type: boolean + - name: user_id + in: query + description: '' + required: false + schema: + type: string + maxLength: 36 + - name: agent_id + in: query + description: '' + required: false + schema: + type: string + maxLength: 36 + - name: server_id + in: query + description: '' + required: false + schema: + type: string + maxLength: 100 + - name: search + in: query + description: '' + required: false + schema: + type: string + maxLength: 64 + - name: created_by + in: query + description: '' + required: false + schema: + type: string + maxLength: 255 + - name: start_time + in: query + description: '' + required: false + schema: + type: string + format: date-time + - name: end_time + in: query + description: '' + required: false + schema: + type: string + format: date-time + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/CurrentPage' + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + object: + type: string + enum: + - list + total: + type: integer + data: + type: array + items: + $ref: '#/components/schemas/AccessPolicyListItem' + '400': + description: '' + '401': + description: '' + '403': + description: '' + '500': + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/access-policies/list-access-policies + servers: + - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 + description: Managed + /policies/access/{accessPolicyId}: + get: + tags: + - Access Policies + summary: '' + description: '' + operationId: getAccessPolicy + parameters: + - $ref: '#/components/parameters/AccessPolicyId' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/AccessPolicy' + '400': + description: '' + '401': + description: '' + '403': + description: '' + '404': + description: '' + '500': + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/access-policies/get-access-policy + put: + tags: + - Access Policies + summary: '' + description: '' + operationId: updateAccessPolicy + parameters: + - $ref: '#/components/parameters/AccessPolicyId' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAccessPolicyRequest' + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + '400': + description: '' + '401': + description: '' + '403': + description: '' + '404': + description: '' + '409': + description: '' + '500': + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/access-policies/update-access-policy + delete: + tags: + - Access Policies + summary: '' + description: '' + operationId: deleteAccessPolicy + parameters: + - $ref: '#/components/parameters/AccessPolicyId' + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + '400': + description: '' + '401': + description: '' + '403': + description: '' + '404': + description: '' + '500': + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/access-policies/delete-access-policy + servers: + - url: https://api.apps.paloaltonetworks.com/ai_gw/v2 + description: Managed + /messages: + post: + operationId: createMessage + tags: + - Messages + summary: '' + description: '' + parameters: + - $ref: '#/components/parameters/PortkeyTraceId' + - $ref: '#/components/parameters/PortkeySpanId' + - $ref: '#/components/parameters/PortkeyParentSpanId' + - $ref: '#/components/parameters/PortkeySpanName' + - $ref: '#/components/parameters/PortkeyMetadata' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateAnthropicMessageRequest' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMessageResponse' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/messages/create-message + /messages/count_tokens: + post: + operationId: countMessageTokens + tags: + - Messages + summary: '' + description: '' + parameters: + - $ref: '#/components/parameters/PortkeyTraceId' + - $ref: '#/components/parameters/PortkeySpanId' + - $ref: '#/components/parameters/PortkeyParentSpanId' + - $ref: '#/components/parameters/PortkeySpanName' + - $ref: '#/components/parameters/PortkeyMetadata' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CountMessageTokensRequest' + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CountMessageTokensResponse' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' + x-mint: + href: /aigw/api-reference/messages/count-message-tokens +components: + securitySchemes: + Authorization: + type: http + scheme: bearer + parameters: + TimeOfGenerationMin: + in: query + name: time_of_generation_min + required: true + schema: + type: string + format: date-time + TimeOfGenerationMax: + in: query + name: time_of_generation_max + required: true + schema: + type: string + format: date-time + TotalUnitsMin: + in: query + name: total_units_min + schema: + type: integer + minimum: 0 + TotalUnitsMax: + in: query + name: total_units_max + schema: + type: integer + minimum: 0 + CostMin: + in: query + name: cost_min + schema: + type: number + minimum: 0 + CostMax: + in: query + name: cost_max + schema: + type: number + minimum: 0 + PromptTokenMin: + in: query + name: prompt_token_min + schema: + type: integer + minimum: 0 + PromptTokenMax: + in: query + name: prompt_token_max + schema: + type: integer + minimum: 0 + CompletionTokenMin: + in: query + name: completion_token_min + schema: + type: integer + minimum: 0 + CompletionTokenMax: + in: query + name: completion_token_max + schema: + type: integer + minimum: 0 + StatusCode: + in: query + name: status_code + schema: + type: string + PageSize: + in: query + name: page_size + schema: + type: integer + minimum: 0 + CurrentPage: + in: query + name: current_page + schema: + type: integer + minimum: 0 + WeightedFeedbackMin: + in: query + name: weighted_feedback_min + schema: + type: number + minimum: -10 + maximum: 10 + WeightedFeedbackMax: + in: query + name: weighted_feedback_max + schema: + type: number + minimum: -10 + maximum: 10 + OrderBy: + in: query + name: order_by + schema: + type: string + OrderByType: + in: query + name: order_by_type + schema: + type: string + VirtualKeys: + in: query + name: virtual_keys + schema: + type: string + Configs: + in: query + name: configs + schema: + type: string WorkspaceSlug: in: query name: workspace_slug @@ -8130,9 +9025,36 @@ components: WorkspaceIdQuery: name: workspace_id in: query - required: false + required: true + schema: + type: string + format: uuid + DeploymentId: + in: query + name: deployment_id + schema: + type: string + description: '' + ExcludeWorkspaceSlugs: + in: query + name: exclude_workspace_slugs + schema: + type: string + description: '' + IncludeAllWorkspaces: + in: query + name: include_all_workspaces + schema: + type: boolean + description: '' + AccessPolicyId: + name: accessPolicyId + in: path + required: true + description: '' schema: type: string + format: uuid schemas: ModelPricingConfig: type: object @@ -9755,7 +10677,172 @@ components: data: type: array items: - $ref: '#/components/schemas/OpenAIFile' + $ref: '#/components/schemas/OpenAIFile' + object: + type: string + enum: + - list + required: + - object + - data + CreateFileRequest: + type: object + additionalProperties: false + properties: + file: + type: string + format: binary + purpose: + type: string + enum: + - assistants + - batch + - fine-tune + - vision + required: + - file + - purpose + DeleteFileResponse: + type: object + properties: + id: + type: string + object: + type: string + enum: + - file + deleted: + type: boolean + required: + - id + - object + - deleted + BedrockFinetuneJob: + type: object + title: Bedrock Params + properties: + job_name: + type: string + role_arn: + type: string + output_file: + type: string + allOf: + - $ref: '#/components/schemas/OpenAIFinetuneJob' + OpenAIFinetuneJob: + type: object + title: OpenAI Params + required: + - model + - training_file + - suffix + - method + properties: + model: + type: string + training_file: + type: string + validation_file: + type: string + suffix: + type: string + method: + type: object + properties: + type: + type: string + enum: + - supervised + - dpo + supervised: + type: object + properties: + hyperparameters: + type: object + properties: + n_epochs: + type: integer + format: int32 + learning_rate_multiplier: + type: number + format: float + batch_size: + type: integer + format: int32 + required: + - n_epochs + - learning_rate_multiplier + - batch_size + required: + - hyperparameters + dpo: + type: object + properties: + hyperparameters: + type: object + properties: + n_epochs: + type: integer + format: int32 + learning_rate_multiplier: + type: number + format: float + batch_size: + type: integer + format: int32 + required: + - n_epochs + - learning_rate_multiplier + - batch_size + required: + - hyperparameters + required: + - type + BedrockParams: + type: object + properties: + job_name: + type: string + role_arn: + type: string + output_file: + type: string + PortkeyFinetuneJob: + type: object + properties: + job_name: + type: string + role_arn: + type: string + output_file: + type: string + portkey_options: + allOf: + - $ref: '#/components/schemas/PortkeyOptions' + provider_options: + allOf: + - $ref: '#/components/schemas/BedrockParams' + allOf: + - $ref: '#/components/schemas/OpenAIFinetuneJob' + title: Portkey Params + PortkeyOptions: + type: object + required: + - x-portkey-virtual-key + properties: + x-portkey-virtual-key: + type: string + x-portkey-aws-s3-bucket: + type: string + x-portkey-vertex-storage-bucket-name: + type: string + ListFineTuningJobEventsResponse: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/FineTuningJobEvent' object: type: string enum: @@ -9763,24 +10850,183 @@ components: required: - object - data - CreateFileRequest: + ListFineTuningJobCheckpointsResponse: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/FineTuningJobCheckpoint' + object: + type: string + enum: + - list + first_id: + type: string + nullable: true + last_id: + type: string + nullable: true + has_more: + type: boolean + required: + - object + - data + - has_more + CreateEmbeddingRequest: type: object additionalProperties: false properties: - file: + input: + oneOf: + - type: string + title: string + default: '' + - type: array + title: array + minItems: 1 + maxItems: 2048 + items: + type: string + default: '' + - type: array + title: array + minItems: 1 + maxItems: 2048 + items: + type: integer + - type: array + title: array + minItems: 1 + maxItems: 2048 + items: + type: array + minItems: 1 + items: + type: integer + x-oaiExpandable: true + model: + anyOf: + - type: string + - type: string + enum: + - text-embedding-ada-002 + - text-embedding-3-small + - text-embedding-3-large + x-oaiTypeLabel: string + encoding_format: + default: float type: string - format: binary - purpose: + enum: + - float + - base64 + dimensions: + type: integer + minimum: 1 + user: + type: string + required: + - model + - input + CreateEmbeddingResponse: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/Embedding' + model: + type: string + object: type: string enum: - - assistants - - batch - - fine-tune - - vision + - list + usage: + type: object + properties: + prompt_tokens: + type: integer + total_tokens: + type: integer + required: + - prompt_tokens + - total_tokens required: - - file - - purpose - DeleteFileResponse: + - object + - model + - data + - usage + RerankDocument: + oneOf: + - type: string + title: string + - type: object + title: object + properties: + text: + type: string + required: + - text + additionalProperties: true + CreateRerankRequest: + type: object + properties: + model: + type: string + query: + type: string + documents: + type: array + items: + $ref: '#/components/schemas/RerankDocument' + minItems: 1 + top_n: + type: integer + minimum: 1 + return_documents: + type: boolean + default: false + max_tokens_per_doc: + type: integer + minimum: 1 + priority: + type: number + rank_fields: + type: array + items: + type: string + truncation: + type: boolean + parameters: + type: object + additionalProperties: true + required: + - model + - query + - documents + RerankResult: + type: object + properties: + index: + type: integer + relevance_score: + type: number + format: float + document: + type: object + properties: + text: + type: string + additionalProperties: true + required: + - index + - relevance_score + RerankUsage: + type: object + properties: + search_units: + type: integer + CreateRerankResponse: type: object properties: id: @@ -9788,1763 +11034,1850 @@ components: object: type: string enum: - - file - deleted: - type: boolean + - list + results: + type: array + items: + $ref: '#/components/schemas/RerankResult' + model: + type: string + usage: + $ref: '#/components/schemas/RerankUsage' + provider: + type: string + required: + - object + - results + - model + DecisionsQuestion: + type: object + description: '' + properties: + type: + description: '' + type: string + enum: + - noul + - choice + - score + instructions: + description: '' + oneOf: + - type: string + - type: object + additionalProperties: true + - type: array + items: {} + x-oaiExpandable: true + criteria: + description: '' + nullable: true + oneOf: + - type: object + additionalProperties: true + - type: array + items: {} + x-oaiExpandable: true + required: + - type + - instructions + CreateDecisionsRequest: + type: object + description: '' + properties: + model: + description: '' + type: string + state: + description: '' + oneOf: + - type: string + - type: object + additionalProperties: true + - type: array + items: {} + x-oaiExpandable: true + questions: + description: '' + type: object + additionalProperties: + $ref: '#/components/schemas/DecisionsQuestion' required: - - id - - object - - deleted - BedrockFinetuneJob: + - state + - model + - questions + DecisionsAnswer: + description: '' + oneOf: + - type: object + title: noul + description: '' + properties: + type: + type: string + enum: + - noul + noul: + type: number + description: '' + required: + - type + - noul + - type: object + title: choice + description: '' + properties: + type: + type: string + enum: + - choice + choice: + type: string + description: '' + probabilities: + type: object + description: '' + additionalProperties: + type: number + confidence: + type: number + description: '' + required: + - type + - choice + - probabilities + - confidence + - type: object + title: score + description: '' + properties: + type: + type: string + enum: + - score + score: + type: number + description: '' + legend: + type: object + description: '' + additionalProperties: + type: string + probabilities: + type: object + description: '' + additionalProperties: + type: number + confidence: + type: number + description: '' + required: + - type + - score + - probabilities + - confidence + x-oaiExpandable: true + CreateDecisionsResponse: type: object - title: Bedrock Params + description: '' properties: - job_name: - type: string - role_arn: + model: type: string - output_file: + description: '' + answers: + type: object + description: '' + additionalProperties: + $ref: '#/components/schemas/DecisionsAnswer' + usage: + type: object + description: '' + properties: + input_tokens: + type: integer + description: '' + output_tokens: + type: integer + description: '' + provider: type: string - allOf: - - $ref: '#/components/schemas/OpenAIFinetuneJob' - OpenAIFinetuneJob: - type: object - title: OpenAI Params + description: '' required: - model - - training_file - - suffix - - method + - answers + CreateOcrRequest: + type: object properties: model: type: string - training_file: - type: string - validation_file: - type: string - suffix: - type: string - method: + document: type: object properties: type: type: string enum: - - supervised - - dpo - supervised: - type: object - properties: - hyperparameters: - type: object - properties: - n_epochs: - type: integer - format: int32 - learning_rate_multiplier: - type: number - format: float - batch_size: - type: integer - format: int32 - required: - - n_epochs - - learning_rate_multiplier - - batch_size - required: - - hyperparameters - dpo: - type: object - properties: - hyperparameters: - type: object - properties: - n_epochs: - type: integer - format: int32 - learning_rate_multiplier: - type: number - format: float - batch_size: - type: integer - format: int32 - required: - - n_epochs - - learning_rate_multiplier - - batch_size - required: - - hyperparameters + - document_url + - image_url + document_url: + type: string + image_url: + type: string required: - type - BedrockParams: - type: object - properties: - job_name: - type: string - role_arn: - type: string - output_file: - type: string - PortkeyFinetuneJob: - type: object - properties: - job_name: - type: string - role_arn: - type: string - output_file: - type: string - portkey_options: - allOf: - - $ref: '#/components/schemas/PortkeyOptions' - provider_options: - allOf: - - $ref: '#/components/schemas/BedrockParams' - allOf: - - $ref: '#/components/schemas/OpenAIFinetuneJob' - title: Portkey Params - PortkeyOptions: - type: object + include_image_base64: + type: boolean + default: false + image_limit: + type: integer + minimum: 1 + image_min_size: + type: integer + minimum: 1 + pages: + type: array + items: + type: integer required: - - x-portkey-virtual-key - properties: - x-portkey-virtual-key: - type: string - x-portkey-aws-s3-bucket: - type: string - x-portkey-vertex-storage-bucket-name: - type: string - ListFineTuningJobEventsResponse: + - model + - document + CreateOcrResponse: type: object properties: - data: + pages: type: array items: - $ref: '#/components/schemas/FineTuningJobEvent' - object: + $ref: '#/components/schemas/OcrPage' + model: type: string - enum: - - list + usage_info: + type: object + properties: + pages_processed: + type: integer required: - - object - - data - ListFineTuningJobCheckpointsResponse: + - pages + - model + OcrPage: type: object properties: - data: + index: + type: integer + markdown: + type: string + images: type: array items: - $ref: '#/components/schemas/FineTuningJobCheckpoint' - object: - type: string - enum: - - list - first_id: - type: string - nullable: true - last_id: - type: string - nullable: true - has_more: - type: boolean + type: object + properties: + id: + type: string + image_base64: + type: string required: - - object - - data - - has_more - CreateEmbeddingRequest: + - index + - markdown + CreateTranscriptionRequest: type: object additionalProperties: false properties: - input: - oneOf: - - type: string - title: string - default: '' - - type: array - title: array - minItems: 1 - maxItems: 2048 - items: - type: string - default: '' - - type: array - title: array - minItems: 1 - maxItems: 2048 - items: - type: integer - - type: array - title: array - minItems: 1 - maxItems: 2048 - items: - type: array - minItems: 1 - items: - type: integer - x-oaiExpandable: true + file: + type: string + x-oaiTypeLabel: file + format: binary model: anyOf: - type: string - type: string enum: - - text-embedding-ada-002 - - text-embedding-3-small - - text-embedding-3-large + - whisper-1 x-oaiTypeLabel: string - encoding_format: - default: float + language: type: string - enum: - - float - - base64 - dimensions: - type: integer - minimum: 1 - user: + prompt: + type: string + response_format: type: string + enum: + - json + - text + - srt + - verbose_json + - vtt + default: json + temperature: + type: number + default: 0 + timestamp_granularities[]: + type: array + items: + type: string + enum: + - word + - segment + default: + - segment required: + - file - model - - input - CreateEmbeddingResponse: + CreateTranscriptionResponseJson: type: object properties: - data: + text: + type: string + required: + - text + TranscriptionSegment: + type: object + properties: + id: + type: integer + seek: + type: integer + start: + type: number + format: float + end: + type: number + format: float + text: + type: string + tokens: type: array items: - $ref: '#/components/schemas/Embedding' - model: - type: string - object: + type: integer + temperature: + type: number + format: float + avg_logprob: + type: number + format: float + compression_ratio: + type: number + format: float + no_speech_prob: + type: number + format: float + required: + - id + - seek + - start + - end + - text + - tokens + - temperature + - avg_logprob + - compression_ratio + - no_speech_prob + TranscriptionWord: + type: object + properties: + word: type: string - enum: - - list - usage: - type: object - properties: - prompt_tokens: - type: integer - total_tokens: - type: integer - required: - - prompt_tokens - - total_tokens + start: + type: number + format: float + end: + type: number + format: float required: - - object - - model - - data - - usage - RerankDocument: - oneOf: - - type: string - title: string - - type: object - title: object - properties: - text: - type: string - required: - - text - additionalProperties: true - CreateRerankRequest: + - word + - start + - end + CreateTranscriptionResponseVerboseJson: type: object properties: - model: + language: type: string - query: + duration: type: string - documents: + text: + type: string + words: type: array items: - $ref: '#/components/schemas/RerankDocument' - minItems: 1 - top_n: - type: integer - minimum: 1 - return_documents: - type: boolean - default: false - max_tokens_per_doc: - type: integer - minimum: 1 - priority: - type: number - rank_fields: + $ref: '#/components/schemas/TranscriptionWord' + segments: type: array items: - type: string - truncation: - type: boolean - parameters: - type: object - additionalProperties: true + $ref: '#/components/schemas/TranscriptionSegment' + required: + - language + - duration + - text + CreateTranslationRequest: + type: object + additionalProperties: false + properties: + file: + type: string + x-oaiTypeLabel: file + format: binary + model: + anyOf: + - type: string + - type: string + enum: + - whisper-1 + x-oaiTypeLabel: string + prompt: + type: string + response_format: + type: string + default: json + temperature: + type: number + default: 0 required: + - file - model - - query - - documents - RerankResult: + CreateTranslationResponseJson: type: object properties: - index: - type: integer - relevance_score: - type: number - format: float - document: - type: object - properties: - text: - type: string - additionalProperties: true + text: + type: string required: - - index - - relevance_score - RerankUsage: + - text + CreateTranslationResponseVerboseJson: type: object properties: - search_units: - type: integer - CreateRerankResponse: + language: + type: string + duration: + type: string + text: + type: string + segments: + type: array + items: + $ref: '#/components/schemas/TranscriptionSegment' + required: + - language + - duration + - text + CreateSpeechRequest: type: object + additionalProperties: false + properties: + model: + anyOf: + - type: string + - type: string + enum: + - tts-1 + - tts-1-hd + x-oaiTypeLabel: string + input: + type: string + maxLength: 4096 + voice: + type: string + enum: + - alloy + - echo + - fable + - onyx + - nova + - shimmer + response_format: + default: mp3 + type: string + enum: + - mp3 + - opus + - aac + - flac + - wav + - pcm + speed: + type: number + default: 1.0 + minimum: 0.25 + maximum: 4.0 + required: + - model + - input + - voice + Model: + title: Model properties: id: type: string + created: + type: integer object: type: string enum: - - list - results: - type: array - items: - $ref: '#/components/schemas/RerankResult' - model: - type: string - usage: - $ref: '#/components/schemas/RerankUsage' - provider: + - model + owned_by: type: string required: + - id - object - - results - - model - DecisionsQuestion: + - created + - owned_by + Move: type: object - description: '' + title: Move properties: type: - description: '' type: string enum: - - noul - - choice - - score - instructions: - description: '' - oneOf: - - type: string - - type: object - additionalProperties: true - - type: array - items: {} - x-oaiExpandable: true - criteria: - description: '' - nullable: true - oneOf: - - type: object - additionalProperties: true - - type: array - items: {} - x-oaiExpandable: true + - move + default: move + x-stainless-const: true + x: + type: integer + y: + type: integer required: - type - - instructions - CreateDecisionsRequest: - type: object - description: '' + - x + - y + OpenAIFile: + title: OpenAIFile properties: - model: - description: '' + id: type: string - state: - description: '' - oneOf: - - type: string - - type: object - additionalProperties: true - - type: array - items: {} - x-oaiExpandable: true - questions: - description: '' - type: object - additionalProperties: - $ref: '#/components/schemas/DecisionsQuestion' - required: - - state - - model - - questions - DecisionsAnswer: - description: '' - oneOf: - - type: object - title: noul - description: '' - properties: - type: - type: string - enum: - - noul - noul: - type: number - description: '' - required: - - type - - noul - - type: object - title: choice - description: '' - properties: - type: - type: string - enum: - - choice - choice: - type: string - description: '' - probabilities: - type: object - description: '' - additionalProperties: - type: number - confidence: - type: number - description: '' - required: - - type - - choice - - probabilities - - confidence - - type: object - title: score - description: '' - properties: - type: - type: string - enum: - - score - score: - type: number - description: '' - legend: - type: object - description: '' - additionalProperties: - type: string - probabilities: - type: object - description: '' - additionalProperties: - type: number - confidence: - type: number - description: '' - required: - - type - - score - - probabilities - - confidence - x-oaiExpandable: true - CreateDecisionsResponse: - type: object - description: '' - properties: - model: + bytes: + type: integer + created_at: + type: integer + filename: + type: string + object: + type: string + enum: + - file + purpose: + type: string + enum: + - assistants + - assistants_output + - batch + - batch_output + - fine-tune + - fine-tune-results + - vision + status: type: string - description: '' - answers: - type: object - description: '' - additionalProperties: - $ref: '#/components/schemas/DecisionsAnswer' - usage: - type: object - description: '' - properties: - input_tokens: - type: integer - description: '' - output_tokens: - type: integer - description: '' - provider: + deprecated: true + enum: + - uploaded + - processed + - error + status_details: type: string - description: '' + deprecated: true required: - - model - - answers - CreateOcrRequest: + - id + - object + - bytes + - created_at + - filename + - purpose + - status + DoubleClick: type: object + title: DoubleClick properties: - model: + type: type: string - document: - type: object - properties: - type: - type: string - enum: - - document_url - - image_url - document_url: - type: string - image_url: - type: string - required: - - type - include_image_base64: - type: boolean - default: false - image_limit: + enum: + - double_click + default: double_click + x-stainless-const: true + x: type: integer - minimum: 1 - image_min_size: + y: type: integer - minimum: 1 - pages: + required: + - type + - x + - y + Drag: + type: object + title: Drag + properties: + type: + type: string + enum: + - drag + default: drag + x-stainless-const: true + path: type: array + x-oaiExpandable: true items: - type: integer + title: Drag path coordinates + x-oaiExpandable: true + $ref: '#/components/schemas/Coordinate' required: - - model - - document - CreateOcrResponse: + - type + - path + EasyInputMessage: type: object + title: Input message properties: - pages: + role: + type: string + enum: + - user + - assistant + - system + - developer + content: + x-oaiExpandable: true + oneOf: + - type: string + title: Text input + - $ref: '#/components/schemas/InputMessageContentList' + type: + type: string + enum: + - message + x-stainless-const: true + required: + - role + - content + Embedding: + type: object + properties: + index: + type: integer + embedding: type: array items: - $ref: '#/components/schemas/OcrPage' - model: + type: number + object: type: string - usage_info: - type: object - properties: - pages_processed: - type: integer + enum: + - embedding required: - - pages - - model - OcrPage: + - index + - object + - embedding + FineTuningJob: type: object + title: FineTuningJob properties: - index: + id: + type: string + created_at: type: integer - markdown: + error: + type: object + nullable: true + properties: + code: + type: string + message: + type: string + param: + type: string + nullable: true + required: + - code + - message + - param + fine_tuned_model: type: string - images: + nullable: true + finished_at: + type: integer + nullable: true + hyperparameters: + type: object + properties: + n_epochs: + oneOf: + - type: string + enum: + - auto + - type: integer + minimum: 1 + maximum: 50 + default: auto + required: + - n_epochs + model: + type: string + object: + type: string + enum: + - fine_tuning.job + organization_id: + type: string + result_files: type: array items: - type: object - properties: - id: - type: string - image_base64: + type: string + status: + type: string + enum: + - validating_files + - queued + - running + - succeeded + - failed + - cancelled + trained_tokens: + type: integer + nullable: true + training_file: + type: string + validation_file: + type: string + nullable: true + integrations: + type: array + nullable: true + maxItems: 5 + items: + oneOf: + - $ref: '#/components/schemas/FineTuningIntegration' + x-oaiExpandable: true + seed: + type: integer + estimated_finish: + type: integer + nullable: true + required: + - created_at + - error + - finished_at + - fine_tuned_model + - hyperparameters + - id + - model + - object + - organization_id + - result_files + - status + - trained_tokens + - training_file + - validation_file + - seed + FineTuningIntegration: + type: object + title: Fine-Tuning Job Integration + required: + - type + - wandb + properties: + type: + type: string + enum: + - wandb + wandb: + type: object + required: + - project + properties: + project: + type: string + name: + nullable: true + type: string + entity: + nullable: true + type: string + tags: + type: array + items: type: string - required: - - index - - markdown - CreateTranscriptionRequest: + FineTuningJobEvent: type: object - additionalProperties: false properties: - file: + id: type: string - x-oaiTypeLabel: file - format: binary - model: - anyOf: - - type: string - - type: string - enum: - - whisper-1 - x-oaiTypeLabel: string - language: + created_at: + type: integer + level: type: string - prompt: + enum: + - info + - warn + - error + message: type: string - response_format: + object: type: string enum: - - json - - text - - srt - - verbose_json - - vtt - default: json - temperature: - type: number - default: 0 - timestamp_granularities[]: - type: array - items: - type: string - enum: - - word - - segment - default: - - segment - required: - - file - - model - CreateTranscriptionResponseJson: - type: object - properties: - text: - type: string + - fine_tuning.job.event required: - - text - TranscriptionSegment: + - id + - object + - created_at + - level + - message + FineTuningJobCheckpoint: type: object + title: FineTuningJobCheckpoint properties: id: + type: string + created_at: type: integer - seek: + fine_tuned_model_checkpoint: + type: string + step_number: type: integer - start: - type: number - format: float - end: - type: number - format: float - text: + metrics: + type: object + properties: + step: + type: number + train_loss: + type: number + train_mean_token_accuracy: + type: number + valid_loss: + type: number + valid_mean_token_accuracy: + type: number + full_valid_loss: + type: number + full_valid_mean_token_accuracy: + type: number + fine_tuning_job_id: type: string - tokens: - type: array - items: - type: integer - temperature: - type: number - format: float - avg_logprob: - type: number - format: float - compression_ratio: - type: number - format: float - no_speech_prob: - type: number - format: float + object: + type: string + enum: + - fine_tuning.job.checkpoint required: + - created_at + - fine_tuning_job_id + - fine_tuned_model_checkpoint - id - - seek - - start - - end - - text - - tokens - - temperature - - avg_logprob - - compression_ratio - - no_speech_prob - TranscriptionWord: + - metrics + - object + - step_number + Click: type: object + title: Click properties: - word: + type: type: string - start: - type: number - format: float - end: - type: number - format: float + enum: + - click + default: click + x-stainless-const: true + button: + type: string + enum: + - left + - right + - wheel + - back + - forward + x: + type: integer + y: + type: integer required: - - word - - start - - end - CreateTranscriptionResponseVerboseJson: + - type + - button + - x + - y + CodeInterpreterFileOutput: type: object + title: Code interpreter file output properties: - language: - type: string - duration: - type: string - text: + type: type: string - words: - type: array - items: - $ref: '#/components/schemas/TranscriptionWord' - segments: + enum: + - files + x-stainless-const: true + files: type: array items: - $ref: '#/components/schemas/TranscriptionSegment' + type: object + properties: + mime_type: + type: string + file_id: + type: string + required: + - mime_type + - file_id required: - - language - - duration - - text - CreateTranslationRequest: + - type + - files + CodeInterpreterTextOutput: type: object - additionalProperties: false + title: Code interpreter text output properties: - file: - type: string - x-oaiTypeLabel: file - format: binary - model: - anyOf: - - type: string - - type: string - enum: - - whisper-1 - x-oaiTypeLabel: string - prompt: - type: string - response_format: + type: type: string - default: json - temperature: - type: number - default: 0 - required: - - file - - model - CreateTranslationResponseJson: - type: object - properties: - text: + enum: + - logs + x-stainless-const: true + logs: type: string required: - - text - CreateTranslationResponseVerboseJson: + - type + - logs + CodeInterpreterToolCall: type: object + title: Code interpreter tool call properties: - language: + id: type: string - duration: + type: type: string - text: + enum: + - code_interpreter_call + x-stainless-const: true + code: type: string - segments: + status: + type: string + enum: + - in_progress + - interpreting + - completed + results: type: array items: - $ref: '#/components/schemas/TranscriptionSegment' + x-oaiExpandable: true + $ref: '#/components/schemas/CodeInterpreterToolOutput' required: - - language - - duration - - text - CreateSpeechRequest: + - id + - type + - code + - status + - results + CodeInterpreterToolOutput: + oneOf: + - $ref: '#/components/schemas/CodeInterpreterTextOutput' + - $ref: '#/components/schemas/CodeInterpreterFileOutput' + ComparisonFilter: type: object additionalProperties: false + title: Comparison Filter properties: - model: - anyOf: - - type: string - - type: string - enum: - - tts-1 - - tts-1-hd - x-oaiTypeLabel: string - input: - type: string - maxLength: 4096 - voice: + type: type: string + default: eq enum: - - alloy - - echo - - fable - - onyx - - nova - - shimmer - response_format: - default: mp3 + - eq + - ne + - gt + - gte + - lt + - lte + key: type: string - enum: - - mp3 - - opus - - aac - - flac - - wav - - pcm - speed: - type: number - default: 1.0 - minimum: 0.25 - maximum: 4.0 + value: + oneOf: + - type: string + - type: number + - type: boolean required: - - model - - input - - voice - Model: - title: Model + - type + - key + - value + CompletionUsage: + type: object properties: - id: - type: string - created: + completion_tokens: type: integer - object: - type: string - enum: - - model - owned_by: - type: string + prompt_tokens: + type: integer + total_tokens: + type: integer + completion_tokens_details: + type: object + nullable: true + properties: + reasoning_tokens: + type: integer + accepted_prediction_tokens: + type: integer + rejected_prediction_tokens: + type: integer + prompt_tokens_details: + type: object + nullable: true + properties: + cached_tokens: + type: integer required: - - id - - object - - created - - owned_by - Move: + - prompt_tokens + - completion_tokens + - total_tokens + CompoundFilter: type: object - title: Move + additionalProperties: false + title: Compound Filter properties: type: type: string enum: - - move - default: move - x-stainless-const: true - x: - type: integer - y: - type: integer + - and + - or + filters: + type: array + items: + oneOf: + - $ref: '#/components/schemas/ComparisonFilter' + - type: object + additionalProperties: true required: - type - - x - - y - OpenAIFile: - title: OpenAIFile + - filters + ComputerAction: + oneOf: + - $ref: '#/components/schemas/Click' + - $ref: '#/components/schemas/DoubleClick' + - $ref: '#/components/schemas/Drag' + - $ref: '#/components/schemas/KeyPress' + - $ref: '#/components/schemas/Move' + - $ref: '#/components/schemas/Screenshot' + - $ref: '#/components/schemas/Scroll' + - $ref: '#/components/schemas/Type' + - $ref: '#/components/schemas/Wait' + ComputerScreenshotImage: + type: object properties: - id: + type: type: string - bytes: - type: integer - created_at: - type: integer - filename: + enum: + - computer_screenshot + default: computer_screenshot + x-stainless-const: true + image_url: type: string - object: + file_id: type: string - enum: - - file - purpose: + required: + - type + ComputerTool: + type: object + title: Computer use + properties: + type: type: string enum: - - assistants - - assistants_output - - batch - - batch_output - - fine-tune - - fine-tune-results - - vision - status: + - computer_use_preview + x-stainless-const: true + display_width: + type: number + display_height: + type: number + environment: type: string - deprecated: true enum: - - uploaded - - processed - - error - status_details: - type: string - deprecated: true + - mac + - windows + - ubuntu + - browser required: - - id - - object - - bytes - - created_at - - filename - - purpose - - status - DoubleClick: + - type + - display_width + - display_height + - environment + ComputerToolCall: type: object - title: DoubleClick + title: Computer tool call properties: type: type: string enum: - - double_click - default: double_click - x-stainless-const: true - x: - type: integer - y: - type: integer + - computer_call + default: computer_call + id: + type: string + call_id: + type: string + action: + $ref: '#/components/schemas/ComputerAction' + x-oaiExpandable: true + pending_safety_checks: + type: array + x-oaiExpandable: true + items: + $ref: '#/components/schemas/ComputerToolCallSafetyCheck' + status: + type: string + enum: + - in_progress + - completed + - incomplete required: - type - - x - - y - Drag: + - id + - action + - call_id + - pending_safety_checks + - status + ComputerToolCallOutput: type: object - title: Drag + title: Computer tool call output properties: type: type: string enum: - - drag - default: drag + - computer_call_output + default: computer_call_output x-stainless-const: true - path: + id: + type: string + call_id: + type: string + acknowledged_safety_checks: type: array x-oaiExpandable: true items: - title: Drag path coordinates - x-oaiExpandable: true - $ref: '#/components/schemas/Coordinate' + $ref: '#/components/schemas/ComputerToolCallSafetyCheck' + output: + $ref: '#/components/schemas/ComputerScreenshotImage' + status: + type: string + enum: + - in_progress + - completed + - incomplete required: - type - - path - EasyInputMessage: + - call_id + - output + ComputerToolCallOutputResource: + allOf: + - $ref: '#/components/schemas/ComputerToolCallOutput' + - type: object + properties: + id: + type: string + required: + - id + ComputerToolCallSafetyCheck: type: object - title: Input message properties: - role: + id: type: string - enum: - - user - - assistant - - system - - developer - content: - x-oaiExpandable: true - oneOf: - - type: string - title: Text input - - $ref: '#/components/schemas/InputMessageContentList' - type: + code: + type: string + message: type: string - enum: - - message - x-stainless-const: true required: - - role - - content - Embedding: + - id + - code + - message + Coordinate: type: object + title: Coordinate properties: - index: + x: + type: integer + y: type: integer - embedding: - type: array - items: - type: number - object: - type: string - enum: - - embedding required: - - index - - object - - embedding - FineTuningJob: + - x + - y + Reasoning: type: object - title: FineTuningJob + title: Reasoning + x-oaiExpandable: true properties: - id: - type: string - created_at: - type: integer - error: - type: object - nullable: true - properties: - code: - type: string - message: - type: string - param: - type: string - nullable: true - required: - - code - - message - - param - fine_tuned_model: + effort: + $ref: '#/components/schemas/ReasoningEffort' + generate_summary: type: string + enum: + - concise + - detailed nullable: true - finished_at: - type: integer - nullable: true - hyperparameters: - type: object - properties: - n_epochs: - oneOf: - - type: string - enum: - - auto - - type: integer - minimum: 1 - maximum: 50 - default: auto - required: - - n_epochs - model: - type: string - object: + ReasoningEffort: + type: string + enum: + - low + - medium + - high + default: medium + nullable: true + ReasoningItem: + type: object + title: Reasoning + x-oaiExpandable: true + properties: + type: type: string enum: - - fine_tuning.job - organization_id: + - reasoning + x-stainless-const: true + id: type: string - result_files: + summary: type: array items: - type: string + type: object + properties: + type: + type: string + enum: + - summary_text + x-stainless-const: true + text: + type: string + required: + - type + - text status: type: string enum: - - validating_files - - queued - - running - - succeeded - - failed - - cancelled - trained_tokens: - type: integer - nullable: true - training_file: - type: string - validation_file: - type: string - nullable: true - integrations: - type: array - nullable: true - maxItems: 5 - items: - oneOf: - - $ref: '#/components/schemas/FineTuningIntegration' - x-oaiExpandable: true - seed: - type: integer - estimated_finish: - type: integer - nullable: true + - in_progress + - completed + - incomplete required: - - created_at - - error - - finished_at - - fine_tuned_model - - hyperparameters - id - - model - - object - - organization_id - - result_files - - status - - trained_tokens - - training_file - - validation_file - - seed - FineTuningIntegration: - type: object - title: Fine-Tuning Job Integration - required: + - summary - type - - wandb + Refusal: + type: object + title: Refusal properties: type: type: string enum: - - wandb - wandb: - type: object - required: - - project - properties: - project: - type: string - name: - nullable: true - type: string - entity: - nullable: true - type: string - tags: - type: array - items: + - refusal + x-stainless-const: true + refusal: + type: string + required: + - type + - refusal + Response: + allOf: + - $ref: '#/components/schemas/ModelResponseProperties' + - $ref: '#/components/schemas/ResponseProperties' + - type: object + properties: + id: + type: string + object: + type: string + enum: + - response + x-stainless-const: true + status: + type: string + enum: + - completed + - failed + - in_progress + - incomplete + created_at: + type: number + error: + $ref: '#/components/schemas/ResponseError' + incomplete_details: + type: object + nullable: true + properties: + reason: type: string - FineTuningJobEvent: + enum: + - max_output_tokens + - content_filter + output: + type: array + x-oaiExpandable: true + items: + $ref: '#/components/schemas/OutputItem' + x-oaiExpandable: true + output_text: + type: string + nullable: true + x-oaiSupportedSDKs: + - python + - javascript + usage: + $ref: '#/components/schemas/ResponseUsage' + parallel_tool_calls: + type: boolean + default: true + required: + - id + - object + - created_at + - error + - incomplete_details + - instructions + - model + - tools + - output + - parallel_tool_calls + - metadata + - tool_choice + - temperature + - top_p + ResponseAudioDeltaEvent: type: object properties: - id: - type: string - created_at: - type: integer - level: + type: type: string enum: - - info - - warn - - error - message: - type: string - object: + - response.audio.delta + x-stainless-const: true + delta: type: string - enum: - - fine_tuning.job.event required: - - id - - object - - created_at - - level - - message - FineTuningJobCheckpoint: + - type + - delta + ResponseAudioDoneEvent: type: object - title: FineTuningJobCheckpoint properties: - id: - type: string - created_at: - type: integer - fine_tuned_model_checkpoint: - type: string - step_number: - type: integer - metrics: - type: object - properties: - step: - type: number - train_loss: - type: number - train_mean_token_accuracy: - type: number - valid_loss: - type: number - valid_mean_token_accuracy: - type: number - full_valid_loss: - type: number - full_valid_mean_token_accuracy: - type: number - fine_tuning_job_id: - type: string - object: + type: type: string enum: - - fine_tuning.job.checkpoint + - response.audio.done + x-stainless-const: true required: - - created_at - - fine_tuning_job_id - - fine_tuned_model_checkpoint - - id - - metrics - - object - - step_number - Click: + - type + - response_id + ResponseAudioTranscriptDeltaEvent: type: object - title: Click properties: type: type: string enum: - - click - default: click + - response.audio.transcript.delta x-stainless-const: true - button: + delta: type: string - enum: - - left - - right - - wheel - - back - - forward - x: - type: integer - y: - type: integer required: - type - - button - - x - - y - CodeInterpreterFileOutput: + - response_id + - delta + ResponseAudioTranscriptDoneEvent: type: object - title: Code interpreter file output properties: type: type: string enum: - - files + - response.audio.transcript.done x-stainless-const: true - files: - type: array - items: - type: object - properties: - mime_type: - type: string - file_id: - type: string - required: - - mime_type - - file_id required: - type - - files - CodeInterpreterTextOutput: + - response_id + ResponseCodeInterpreterCallCodeDeltaEvent: type: object - title: Code interpreter text output properties: type: type: string enum: - - logs + - response.code_interpreter_call.code.delta x-stainless-const: true - logs: + output_index: + type: integer + delta: type: string required: - type - - logs - CodeInterpreterToolCall: + - response_id + - output_index + - delta + ResponseCodeInterpreterCallCodeDoneEvent: type: object - title: Code interpreter tool call properties: - id: - type: string type: type: string enum: - - code_interpreter_call + - response.code_interpreter_call.code.done x-stainless-const: true + output_index: + type: integer code: type: string - status: - type: string - enum: - - in_progress - - interpreting - - completed - results: - type: array - items: - x-oaiExpandable: true - $ref: '#/components/schemas/CodeInterpreterToolOutput' required: - - id - type + - response_id + - output_index - code - - status - - results - CodeInterpreterToolOutput: - oneOf: - - $ref: '#/components/schemas/CodeInterpreterTextOutput' - - $ref: '#/components/schemas/CodeInterpreterFileOutput' - ComparisonFilter: + ResponseCodeInterpreterCallCompletedEvent: type: object - additionalProperties: false - title: Comparison Filter properties: type: type: string - default: eq enum: - - eq - - ne - - gt - - gte - - lt - - lte - key: + - response.code_interpreter_call.completed + x-stainless-const: true + output_index: + type: integer + code_interpreter_call: + $ref: '#/components/schemas/CodeInterpreterToolCall' + required: + - type + - response_id + - output_index + - code_interpreter_call + ResponseCodeInterpreterCallInProgressEvent: + type: object + properties: + type: type: string - value: - oneOf: - - type: string - - type: number - - type: boolean + enum: + - response.code_interpreter_call.in_progress + x-stainless-const: true + output_index: + type: integer + code_interpreter_call: + $ref: '#/components/schemas/CodeInterpreterToolCall' required: - type - - key - - value - CompletionUsage: + - response_id + - output_index + - code_interpreter_call + ResponseCodeInterpreterCallInterpretingEvent: type: object properties: - completion_tokens: - type: integer - prompt_tokens: - type: integer - total_tokens: + type: + type: string + enum: + - response.code_interpreter_call.interpreting + x-stainless-const: true + output_index: type: integer - completion_tokens_details: - type: object - nullable: true - properties: - reasoning_tokens: - type: integer - accepted_prediction_tokens: - type: integer - rejected_prediction_tokens: - type: integer - prompt_tokens_details: - type: object - nullable: true - properties: - cached_tokens: - type: integer + code_interpreter_call: + $ref: '#/components/schemas/CodeInterpreterToolCall' required: - - prompt_tokens - - completion_tokens - - total_tokens - CompoundFilter: + - type + - response_id + - output_index + - code_interpreter_call + ResponseCompletedEvent: type: object - additionalProperties: false - title: Compound Filter properties: type: type: string enum: - - and - - or - filters: - type: array - items: - oneOf: - - $ref: '#/components/schemas/ComparisonFilter' - - type: object - additionalProperties: true + - response.completed + x-stainless-const: true + response: + $ref: '#/components/schemas/Response' required: - type - - filters - ComputerAction: - oneOf: - - $ref: '#/components/schemas/Click' - - $ref: '#/components/schemas/DoubleClick' - - $ref: '#/components/schemas/Drag' - - $ref: '#/components/schemas/KeyPress' - - $ref: '#/components/schemas/Move' - - $ref: '#/components/schemas/Screenshot' - - $ref: '#/components/schemas/Scroll' - - $ref: '#/components/schemas/Type' - - $ref: '#/components/schemas/Wait' - ComputerScreenshotImage: + - response + ResponseContentPartAddedEvent: type: object properties: type: type: string enum: - - computer_screenshot - default: computer_screenshot + - response.content_part.added x-stainless-const: true - image_url: - type: string - file_id: + item_id: type: string + output_index: + type: integer + content_index: + type: integer + part: + x-oaiExpandable: true + $ref: '#/components/schemas/OutputContent' required: - type - ComputerTool: + - item_id + - output_index + - content_index + - part + ResponseContentPartDoneEvent: type: object - title: Computer use properties: type: type: string enum: - - computer_use_preview + - response.content_part.done x-stainless-const: true - display_width: - type: number - display_height: - type: number - environment: + item_id: + type: string + output_index: + type: integer + content_index: + type: integer + part: + x-oaiExpandable: true + $ref: '#/components/schemas/OutputContent' + required: + - type + - item_id + - output_index + - content_index + - part + ResponseCreatedEvent: + type: object + properties: + type: type: string enum: - - mac - - windows - - ubuntu - - browser + - response.created + x-stainless-const: true + response: + $ref: '#/components/schemas/Response' required: - type - - display_width - - display_height - - environment - ComputerToolCall: + - response + ResponseError: + type: object + nullable: true + properties: + code: + $ref: '#/components/schemas/ResponseErrorCode' + message: + type: string + required: + - code + - message + ResponseErrorCode: + type: string + enum: + - server_error + - rate_limit_exceeded + - invalid_prompt + - vector_store_timeout + - invalid_image + - invalid_image_format + - invalid_base64_image + - invalid_image_url + - image_too_large + - image_too_small + - image_parse_error + - image_content_policy_violation + - invalid_image_mode + - image_file_too_large + - unsupported_image_media_type + - empty_image_file + - failed_to_download_image + - image_file_not_found + ResponseErrorEvent: type: object - title: Computer tool call properties: type: type: string enum: - - computer_call - default: computer_call - id: + - error + x-stainless-const: true + code: type: string - call_id: + nullable: true + message: type: string - action: - $ref: '#/components/schemas/ComputerAction' - x-oaiExpandable: true - pending_safety_checks: - type: array - x-oaiExpandable: true - items: - $ref: '#/components/schemas/ComputerToolCallSafetyCheck' - status: + param: type: string - enum: - - in_progress - - completed - - incomplete + nullable: true required: - type - - id - - action - - call_id - - pending_safety_checks - - status - ComputerToolCallOutput: + - code + - message + - param + ResponseFailedEvent: type: object - title: Computer tool call output properties: type: type: string enum: - - computer_call_output - default: computer_call_output + - response.failed x-stainless-const: true - id: - type: string - call_id: - type: string - acknowledged_safety_checks: - type: array - x-oaiExpandable: true - items: - $ref: '#/components/schemas/ComputerToolCallSafetyCheck' - output: - $ref: '#/components/schemas/ComputerScreenshotImage' - status: + response: + $ref: '#/components/schemas/Response' + required: + - type + - response + ResponseFileSearchCallCompletedEvent: + type: object + properties: + type: type: string enum: - - in_progress - - completed - - incomplete + - response.file_search_call.completed + x-stainless-const: true + output_index: + type: integer + item_id: + type: string required: - type - - call_id - - output - ComputerToolCallOutputResource: - allOf: - - $ref: '#/components/schemas/ComputerToolCallOutput' - - type: object - properties: - id: - type: string - required: - - id - ComputerToolCallSafetyCheck: + - output_index + - item_id + ResponseFileSearchCallInProgressEvent: type: object properties: - id: - type: string - code: + type: type: string - message: + enum: + - response.file_search_call.in_progress + x-stainless-const: true + output_index: + type: integer + item_id: type: string required: - - id - - code - - message - Coordinate: + - type + - output_index + - item_id + ResponseFileSearchCallSearchingEvent: type: object - title: Coordinate properties: - x: - type: integer - y: + type: + type: string + enum: + - response.file_search_call.searching + x-stainless-const: true + output_index: type: integer + item_id: + type: string required: - - x - - y - Reasoning: + - type + - output_index + - item_id + ResponseFormatJsonObject: type: object - title: Reasoning - x-oaiExpandable: true + title: JSON object properties: - effort: - $ref: '#/components/schemas/ReasoningEffort' - generate_summary: + type: type: string enum: - - concise - - detailed - nullable: true - ReasoningEffort: - type: string - enum: - - low - - medium - - high - default: medium - nullable: true - ReasoningItem: + - json_object + x-stainless-const: true + required: + - type + ResponseFormatJsonSchema: type: object - title: Reasoning - x-oaiExpandable: true + title: JSON schema properties: type: type: string enum: - - reasoning + - json_schema x-stainless-const: true - id: - type: string - summary: - type: array - items: - type: object - properties: - type: - type: string - enum: - - summary_text - x-stainless-const: true - text: - type: string - required: - - type - - text - status: - type: string - enum: - - in_progress - - completed - - incomplete + json_schema: + type: object + title: JSON schema + properties: + description: + type: string + name: + type: string + schema: + $ref: '#/components/schemas/ResponseFormatJsonSchemaSchema' + strict: + type: boolean + nullable: true + default: false + required: + - name required: - - id - - summary - type - Refusal: + - json_schema + ResponseFormatJsonSchemaSchema: type: object - title: Refusal + title: JSON schema + additionalProperties: true + ResponseFormatText: + type: object + title: Text properties: type: type: string enum: - - refusal + - text x-stainless-const: true - refusal: - type: string required: - type - - refusal - Response: - allOf: - - $ref: '#/components/schemas/ModelResponseProperties' - - $ref: '#/components/schemas/ResponseProperties' - - type: object - properties: - id: - type: string - object: - type: string - enum: - - response - x-stainless-const: true - status: - type: string - enum: - - completed - - failed - - in_progress - - incomplete - created_at: - type: number - error: - $ref: '#/components/schemas/ResponseError' - incomplete_details: - type: object - nullable: true - properties: - reason: - type: string - enum: - - max_output_tokens - - content_filter - output: - type: array - x-oaiExpandable: true - items: - $ref: '#/components/schemas/OutputItem' - x-oaiExpandable: true - output_text: - type: string - nullable: true - x-oaiSupportedSDKs: - - python - - javascript - usage: - $ref: '#/components/schemas/ResponseUsage' - parallel_tool_calls: - type: boolean - default: true - required: - - id - - object - - created_at - - error - - incomplete_details - - instructions - - model - - tools - - output - - parallel_tool_calls - - metadata - - tool_choice - - temperature - - top_p - ResponseAudioDeltaEvent: + ResponseFunctionCallArgumentsDeltaEvent: type: object properties: type: type: string enum: - - response.audio.delta + - response.function_call_arguments.delta x-stainless-const: true + item_id: + type: string + output_index: + type: integer delta: type: string required: - type + - item_id + - output_index - delta - ResponseAudioDoneEvent: + ResponseFunctionCallArgumentsDoneEvent: type: object properties: type: type: string enum: - - response.audio.done + - response.function_call_arguments.done x-stainless-const: true + item_id: + type: string + output_index: + type: integer + arguments: + type: string required: - type - - response_id - ResponseAudioTranscriptDeltaEvent: + - item_id + - output_index + - arguments + ResponseInProgressEvent: type: object properties: type: type: string enum: - - response.audio.transcript.delta + - response.in_progress x-stainless-const: true - delta: - type: string + response: + $ref: '#/components/schemas/Response' required: - type - - response_id - - delta - ResponseAudioTranscriptDoneEvent: + - response + ResponseIncompleteEvent: type: object properties: type: type: string enum: - - response.audio.transcript.done + - response.incomplete x-stainless-const: true + response: + $ref: '#/components/schemas/Response' required: - type - - response_id - ResponseCodeInterpreterCallCodeDeltaEvent: + - response + ResponseItemList: type: object properties: - type: + object: type: string enum: - - response.code_interpreter_call.code.delta + - list x-stainless-const: true - output_index: - type: integer - delta: + data: + type: array + items: + $ref: '#/components/schemas/ItemResource' + has_more: + type: boolean + first_id: + type: string + last_id: type: string required: - - type - - response_id - - output_index - - delta - ResponseCodeInterpreterCallCodeDoneEvent: + - object + - data + - has_more + - first_id + - last_id + x-oaiExpandable: true + ResponseOutputItemAddedEvent: type: object properties: type: type: string enum: - - response.code_interpreter_call.code.done + - response.output_item.added x-stainless-const: true output_index: type: integer - code: - type: string + item: + $ref: '#/components/schemas/OutputItem' + x-oaiExpandable: true required: - type - - response_id - output_index - - code - ResponseCodeInterpreterCallCompletedEvent: + - item + ResponseOutputItemDoneEvent: type: object properties: type: type: string enum: - - response.code_interpreter_call.completed + - response.output_item.done x-stainless-const: true output_index: type: integer - code_interpreter_call: - $ref: '#/components/schemas/CodeInterpreterToolCall' + item: + $ref: '#/components/schemas/OutputItem' + x-oaiExpandable: true required: - type - - response_id - output_index - - code_interpreter_call - ResponseCodeInterpreterCallInProgressEvent: + - item + ResponseProperties: type: object properties: - type: + previous_response_id: type: string - enum: - - response.code_interpreter_call.in_progress - x-stainless-const: true - output_index: + nullable: true + model: + $ref: '#/components/schemas/ModelIdsResponses' + reasoning: + $ref: '#/components/schemas/Reasoning' + nullable: true + max_output_tokens: type: integer - code_interpreter_call: - $ref: '#/components/schemas/CodeInterpreterToolCall' - required: - - type - - response_id - - output_index - - code_interpreter_call - ResponseCodeInterpreterCallInterpretingEvent: + nullable: true + instructions: + type: string + nullable: true + text: + type: object + properties: + format: + $ref: '#/components/schemas/TextResponseFormatConfiguration' + tools: + type: array + items: + $ref: '#/components/schemas/Tool' + tool_choice: + x-oaiExpandable: true + oneOf: + - $ref: '#/components/schemas/ToolChoiceOptions' + - $ref: '#/components/schemas/ToolChoiceTypes' + - $ref: '#/components/schemas/ToolChoiceFunction' + truncation: + type: string + enum: + - auto + - disabled + nullable: true + default: disabled + ResponseRefusalDeltaEvent: type: object properties: type: type: string enum: - - response.code_interpreter_call.interpreting + - response.refusal.delta x-stainless-const: true + item_id: + type: string output_index: type: integer - code_interpreter_call: - $ref: '#/components/schemas/CodeInterpreterToolCall' - required: - - type - - response_id - - output_index - - code_interpreter_call - ResponseCompletedEvent: - type: object - properties: - type: + content_index: + type: integer + delta: type: string - enum: - - response.completed - x-stainless-const: true - response: - $ref: '#/components/schemas/Response' required: - type - - response - ResponseContentPartAddedEvent: + - item_id + - output_index + - content_index + - delta + ResponseRefusalDoneEvent: type: object properties: type: type: string enum: - - response.content_part.added + - response.refusal.done x-stainless-const: true item_id: type: string @@ -11552,22 +12885,57 @@ components: type: integer content_index: type: integer - part: - x-oaiExpandable: true - $ref: '#/components/schemas/OutputContent' + refusal: + type: string required: - type - item_id - output_index - content_index - - part - ResponseContentPartDoneEvent: + - refusal + ResponseStreamEvent: + anyOf: + - $ref: '#/components/schemas/ResponseAudioDeltaEvent' + - $ref: '#/components/schemas/ResponseAudioDoneEvent' + - $ref: '#/components/schemas/ResponseAudioTranscriptDeltaEvent' + - $ref: '#/components/schemas/ResponseAudioTranscriptDoneEvent' + - $ref: '#/components/schemas/ResponseCodeInterpreterCallCodeDeltaEvent' + - $ref: '#/components/schemas/ResponseCodeInterpreterCallCodeDoneEvent' + - $ref: '#/components/schemas/ResponseCodeInterpreterCallCompletedEvent' + - $ref: '#/components/schemas/ResponseCodeInterpreterCallInProgressEvent' + - $ref: '#/components/schemas/ResponseCodeInterpreterCallInterpretingEvent' + - $ref: '#/components/schemas/ResponseCompletedEvent' + - $ref: '#/components/schemas/ResponseContentPartAddedEvent' + - $ref: '#/components/schemas/ResponseContentPartDoneEvent' + - $ref: '#/components/schemas/ResponseCreatedEvent' + - $ref: '#/components/schemas/ResponseErrorEvent' + - $ref: '#/components/schemas/ResponseFileSearchCallCompletedEvent' + - $ref: '#/components/schemas/ResponseFileSearchCallInProgressEvent' + - $ref: '#/components/schemas/ResponseFileSearchCallSearchingEvent' + - $ref: '#/components/schemas/ResponseFunctionCallArgumentsDeltaEvent' + - $ref: '#/components/schemas/ResponseFunctionCallArgumentsDoneEvent' + - $ref: '#/components/schemas/ResponseInProgressEvent' + - $ref: '#/components/schemas/ResponseFailedEvent' + - $ref: '#/components/schemas/ResponseIncompleteEvent' + - $ref: '#/components/schemas/ResponseOutputItemAddedEvent' + - $ref: '#/components/schemas/ResponseOutputItemDoneEvent' + - $ref: '#/components/schemas/ResponseRefusalDeltaEvent' + - $ref: '#/components/schemas/ResponseRefusalDoneEvent' + - $ref: '#/components/schemas/ResponseTextAnnotationDeltaEvent' + - $ref: '#/components/schemas/ResponseTextDeltaEvent' + - $ref: '#/components/schemas/ResponseTextDoneEvent' + - $ref: '#/components/schemas/ResponseWebSearchCallCompletedEvent' + - $ref: '#/components/schemas/ResponseWebSearchCallInProgressEvent' + - $ref: '#/components/schemas/ResponseWebSearchCallSearchingEvent' + discriminator: + propertyName: type + ResponseTextAnnotationDeltaEvent: type: object properties: type: type: string enum: - - response.content_part.done + - response.output_text.annotation.added x-stainless-const: true item_id: type: string @@ -11575,101 +12943,97 @@ components: type: integer content_index: type: integer - part: - x-oaiExpandable: true - $ref: '#/components/schemas/OutputContent' + annotation_index: + type: integer + annotation: + $ref: '#/components/schemas/Annotation' required: - type - item_id - output_index - content_index - - part - ResponseCreatedEvent: + - annotation_index + - annotation + ResponseTextDeltaEvent: type: object properties: type: type: string enum: - - response.created + - response.output_text.delta x-stainless-const: true - response: - $ref: '#/components/schemas/Response' - required: - - type - - response - ResponseError: - type: object - nullable: true - properties: - code: - $ref: '#/components/schemas/ResponseErrorCode' - message: + item_id: + type: string + output_index: + type: integer + content_index: + type: integer + delta: type: string required: - - code - - message - ResponseErrorCode: - type: string - enum: - - server_error - - rate_limit_exceeded - - invalid_prompt - - vector_store_timeout - - invalid_image - - invalid_image_format - - invalid_base64_image - - invalid_image_url - - image_too_large - - image_too_small - - image_parse_error - - image_content_policy_violation - - invalid_image_mode - - image_file_too_large - - unsupported_image_media_type - - empty_image_file - - failed_to_download_image - - image_file_not_found - ResponseErrorEvent: + - type + - item_id + - output_index + - content_index + - delta + ResponseTextDoneEvent: type: object properties: type: type: string enum: - - error + - response.output_text.done x-stainless-const: true - code: - type: string - nullable: true - message: + item_id: type: string - param: + output_index: + type: integer + content_index: + type: integer + text: type: string - nullable: true required: - type - - code - - message - - param - ResponseFailedEvent: + - item_id + - output_index + - content_index + - text + ResponseUsage: type: object properties: - type: - type: string - enum: - - response.failed - x-stainless-const: true - response: - $ref: '#/components/schemas/Response' + input_tokens: + type: integer + input_tokens_details: + type: object + properties: + cached_tokens: + type: integer + required: + - cached_tokens + output_tokens: + type: integer + output_tokens_details: + type: object + properties: + reasoning_tokens: + type: integer + required: + - reasoning_tokens + total_tokens: + type: integer required: - - type - - response - ResponseFileSearchCallCompletedEvent: + - input_tokens + - input_tokens_details + - output_tokens + - output_tokens_details + - total_tokens + ResponseWebSearchCallCompletedEvent: type: object properties: type: type: string enum: - - response.file_search_call.completed + - response.web_search_call.completed x-stainless-const: true output_index: type: integer @@ -11679,13 +13043,13 @@ components: - type - output_index - item_id - ResponseFileSearchCallInProgressEvent: + ResponseWebSearchCallInProgressEvent: type: object properties: type: type: string enum: - - response.file_search_call.in_progress + - response.web_search_call.in_progress x-stainless-const: true output_index: type: integer @@ -11695,13 +13059,13 @@ components: - type - output_index - item_id - ResponseFileSearchCallSearchingEvent: + ResponseWebSearchCallSearchingEvent: type: object properties: type: type: string enum: - - response.file_search_call.searching + - response.web_search_call.searching x-stainless-const: true output_index: type: integer @@ -11711,571 +13075,711 @@ components: - type - output_index - item_id - ResponseFormatJsonObject: + RunCompletionUsage: type: object - title: JSON object properties: - type: - type: string - enum: - - json_object - x-stainless-const: true + completion_tokens: + type: integer + prompt_tokens: + type: integer + total_tokens: + type: integer required: - - type - ResponseFormatJsonSchema: + - prompt_tokens + - completion_tokens + - total_tokens + nullable: true + RunStepCompletionUsage: type: object - title: JSON schema properties: - type: - type: string - enum: - - json_schema - x-stainless-const: true - json_schema: - type: object - title: JSON schema - properties: - description: - type: string - name: - type: string - schema: - $ref: '#/components/schemas/ResponseFormatJsonSchemaSchema' - strict: - type: boolean - nullable: true - default: false - required: - - name + completion_tokens: + type: integer + prompt_tokens: + type: integer + total_tokens: + type: integer required: - - type - - json_schema - ResponseFormatJsonSchemaSchema: - type: object - title: JSON schema - additionalProperties: true - ResponseFormatText: + - prompt_tokens + - completion_tokens + - total_tokens + nullable: true + AssistantsApiResponseFormatOption: + oneOf: + - type: string + enum: + - none + - auto + - $ref: '#/components/schemas/AssistantsApiResponseFormat' + x-oaiExpandable: true + AssistantsApiResponseFormat: type: object - title: Text properties: type: type: string enum: - text - x-stainless-const: true - required: - - type - ResponseFunctionCallArgumentsDeltaEvent: + - json_object + default: text + Annotation: + oneOf: + - $ref: '#/components/schemas/FileCitation' + - $ref: '#/components/schemas/UrlCitation' + - $ref: '#/components/schemas/FilePath' + AssistantObject: type: object + title: Assistant properties: - type: + id: type: string - enum: - - response.function_call_arguments.delta - x-stainless-const: true - item_id: + object: type: string - output_index: + enum: + - assistant + created_at: type: integer - delta: - type: string - required: - - type - - item_id - - output_index - - delta - ResponseFunctionCallArgumentsDoneEvent: - type: object - properties: - type: + name: type: string - enum: - - response.function_call_arguments.done - x-stainless-const: true - item_id: + maxLength: 256 + nullable: true + description: type: string - output_index: - type: integer - arguments: + maxLength: 512 + nullable: true + model: type: string - required: - - type - - item_id - - output_index - - arguments - ResponseInProgressEvent: - type: object - properties: - type: + instructions: type: string - enum: - - response.in_progress - x-stainless-const: true - response: - $ref: '#/components/schemas/Response' + maxLength: 256000 + nullable: true + tools: + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: '#/components/schemas/AssistantToolsCode' + - $ref: '#/components/schemas/AssistantToolsFileSearch' + - $ref: '#/components/schemas/AssistantToolsFunction' + x-oaiExpandable: true + tool_resources: + type: object + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + maxItems: 1 + items: + type: string + nullable: true + metadata: + type: object + x-oaiTypeLabel: map + nullable: true + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + nullable: true + response_format: + $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + nullable: true required: - - type - - response - ResponseIncompleteEvent: + - id + - object + - created_at + - name + - description + - model + - instructions + - tools + - metadata + CreateAssistantRequest: type: object + additionalProperties: false properties: - type: + model: + anyOf: + - type: string + - type: string + enum: + - gpt-4o + - gpt-4o-2024-05-13 + - 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 + x-oaiTypeLabel: string + name: type: string - enum: - - response.incomplete - x-stainless-const: true - response: - $ref: '#/components/schemas/Response' - required: - - type - - response - ResponseItemList: - type: object - properties: - object: + nullable: true + maxLength: 256 + description: type: string - enum: - - list - x-stainless-const: true - data: + nullable: true + maxLength: 512 + instructions: + type: string + nullable: true + maxLength: 256000 + tools: + default: [] type: array + maxItems: 128 items: - $ref: '#/components/schemas/ItemResource' - has_more: - type: boolean - first_id: - type: string - last_id: - type: string + oneOf: + - $ref: '#/components/schemas/AssistantToolsCode' + - $ref: '#/components/schemas/AssistantToolsFileSearch' + - $ref: '#/components/schemas/AssistantToolsFunction' + x-oaiExpandable: true + tool_resources: + type: object + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + maxItems: 1 + items: + type: string + vector_stores: + type: array + maxItems: 1 + items: + type: object + properties: + file_ids: + type: array + maxItems: 10000 + items: + type: string + chunking_strategy: + type: object + oneOf: + - type: object + title: Auto Chunking Strategy + additionalProperties: false + properties: + type: + type: string + enum: + - auto + required: + - type + - type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + enum: + - static + static: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + chunk_overlap_tokens: + type: integer + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + required: + - type + - static + x-oaiExpandable: true + metadata: + type: object + x-oaiTypeLabel: map + oneOf: + - required: + - vector_store_ids + - required: + - vector_stores + nullable: true + metadata: + type: object + x-oaiTypeLabel: map + nullable: true + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + nullable: true + response_format: + $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + nullable: true required: - - object - - data - - has_more - - first_id - - last_id - x-oaiExpandable: true - ResponseOutputItemAddedEvent: + - model + Metadata: type: object - properties: - type: - type: string - enum: - - response.output_item.added - x-stainless-const: true - output_index: - type: integer - item: - $ref: '#/components/schemas/OutputItem' - x-oaiExpandable: true - required: - - type - - output_index - - item - ResponseOutputItemDoneEvent: + additionalProperties: + type: string + x-oaiTypeLabel: map + nullable: true + ModelIdsResponses: + anyOf: + - type: string + enum: + - o1-pro + - o1-pro-2025-03-19 + - computer-use-preview + - computer-use-preview-2025-03-11 + ModelResponseProperties: type: object properties: - type: + metadata: + $ref: '#/components/schemas/Metadata' + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + nullable: true + user: type: string - enum: - - response.output_item.done - x-stainless-const: true - output_index: - type: integer - item: - $ref: '#/components/schemas/OutputItem' - x-oaiExpandable: true - required: - - type - - output_index - - item - ResponseProperties: + ModifyAssistantRequest: type: object + additionalProperties: false properties: - previous_response_id: + model: + anyOf: + - type: string + name: type: string nullable: true - model: - $ref: '#/components/schemas/ModelIdsResponses' - reasoning: - $ref: '#/components/schemas/Reasoning' + maxLength: 256 + description: + type: string + nullable: true + maxLength: 512 + instructions: + type: string + nullable: true + maxLength: 256000 + tools: + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: '#/components/schemas/AssistantToolsCode' + - $ref: '#/components/schemas/AssistantToolsFileSearch' + - $ref: '#/components/schemas/AssistantToolsFunction' + x-oaiExpandable: true + tool_resources: + type: object + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + maxItems: 1 + items: + type: string nullable: true - max_output_tokens: - type: integer + metadata: + type: object + x-oaiTypeLabel: map nullable: true - instructions: - type: string + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 nullable: true - text: - type: object - properties: - format: - $ref: '#/components/schemas/TextResponseFormatConfiguration' - tools: - type: array - items: - $ref: '#/components/schemas/Tool' - tool_choice: - x-oaiExpandable: true - oneOf: - - $ref: '#/components/schemas/ToolChoiceOptions' - - $ref: '#/components/schemas/ToolChoiceTypes' - - $ref: '#/components/schemas/ToolChoiceFunction' - truncation: - type: string - enum: - - auto - - disabled + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 nullable: true - default: disabled - ResponseRefusalDeltaEvent: + response_format: + $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + nullable: true + DeleteAssistantResponse: type: object properties: - type: - type: string - enum: - - response.refusal.delta - x-stainless-const: true - item_id: + id: type: string - output_index: - type: integer - content_index: - type: integer - delta: + deleted: + type: boolean + object: type: string + enum: + - assistant.deleted required: - - type - - item_id - - output_index - - content_index - - delta - ResponseRefusalDoneEvent: + - id + - object + - deleted + Item: + type: object + oneOf: + - $ref: '#/components/schemas/InputMessage' + - $ref: '#/components/schemas/OutputMessage' + - $ref: '#/components/schemas/FileSearchToolCall' + - $ref: '#/components/schemas/ComputerToolCall' + - $ref: '#/components/schemas/ComputerToolCallOutput' + - $ref: '#/components/schemas/WebSearchToolCall' + - $ref: '#/components/schemas/FunctionToolCall' + - $ref: '#/components/schemas/FunctionToolCallOutput' + - $ref: '#/components/schemas/ReasoningItem' + x-oaiExpandable: true + discriminator: + propertyName: type + ItemReference: type: object + title: Item reference properties: + id: + type: string type: type: string enum: - - response.refusal.done + - item_reference x-stainless-const: true - item_id: - type: string - output_index: - type: integer - content_index: - type: integer - refusal: - type: string required: + - id - type - - item_id - - output_index - - content_index - - refusal - ResponseStreamEvent: - anyOf: - - $ref: '#/components/schemas/ResponseAudioDeltaEvent' - - $ref: '#/components/schemas/ResponseAudioDoneEvent' - - $ref: '#/components/schemas/ResponseAudioTranscriptDeltaEvent' - - $ref: '#/components/schemas/ResponseAudioTranscriptDoneEvent' - - $ref: '#/components/schemas/ResponseCodeInterpreterCallCodeDeltaEvent' - - $ref: '#/components/schemas/ResponseCodeInterpreterCallCodeDoneEvent' - - $ref: '#/components/schemas/ResponseCodeInterpreterCallCompletedEvent' - - $ref: '#/components/schemas/ResponseCodeInterpreterCallInProgressEvent' - - $ref: '#/components/schemas/ResponseCodeInterpreterCallInterpretingEvent' - - $ref: '#/components/schemas/ResponseCompletedEvent' - - $ref: '#/components/schemas/ResponseContentPartAddedEvent' - - $ref: '#/components/schemas/ResponseContentPartDoneEvent' - - $ref: '#/components/schemas/ResponseCreatedEvent' - - $ref: '#/components/schemas/ResponseErrorEvent' - - $ref: '#/components/schemas/ResponseFileSearchCallCompletedEvent' - - $ref: '#/components/schemas/ResponseFileSearchCallInProgressEvent' - - $ref: '#/components/schemas/ResponseFileSearchCallSearchingEvent' - - $ref: '#/components/schemas/ResponseFunctionCallArgumentsDeltaEvent' - - $ref: '#/components/schemas/ResponseFunctionCallArgumentsDoneEvent' - - $ref: '#/components/schemas/ResponseInProgressEvent' - - $ref: '#/components/schemas/ResponseFailedEvent' - - $ref: '#/components/schemas/ResponseIncompleteEvent' - - $ref: '#/components/schemas/ResponseOutputItemAddedEvent' - - $ref: '#/components/schemas/ResponseOutputItemDoneEvent' - - $ref: '#/components/schemas/ResponseRefusalDeltaEvent' - - $ref: '#/components/schemas/ResponseRefusalDoneEvent' - - $ref: '#/components/schemas/ResponseTextAnnotationDeltaEvent' - - $ref: '#/components/schemas/ResponseTextDeltaEvent' - - $ref: '#/components/schemas/ResponseTextDoneEvent' - - $ref: '#/components/schemas/ResponseWebSearchCallCompletedEvent' - - $ref: '#/components/schemas/ResponseWebSearchCallInProgressEvent' - - $ref: '#/components/schemas/ResponseWebSearchCallSearchingEvent' + ItemResource: + oneOf: + - $ref: '#/components/schemas/InputMessageResource' + - $ref: '#/components/schemas/OutputMessage' + - $ref: '#/components/schemas/FileSearchToolCall' + - $ref: '#/components/schemas/ComputerToolCall' + - $ref: '#/components/schemas/ComputerToolCallOutputResource' + - $ref: '#/components/schemas/WebSearchToolCall' + - $ref: '#/components/schemas/FunctionToolCallResource' + - $ref: '#/components/schemas/FunctionToolCallOutputResource' + x-oaiExpandable: true discriminator: propertyName: type - ResponseTextAnnotationDeltaEvent: + KeyPress: type: object + title: KeyPress properties: type: type: string enum: - - response.output_text.annotation.added + - keypress + default: keypress x-stainless-const: true - item_id: - type: string - output_index: - type: integer - content_index: - type: integer - annotation_index: - type: integer - annotation: - $ref: '#/components/schemas/Annotation' + keys: + type: array + items: + type: string required: - type - - item_id - - output_index - - content_index - - annotation_index - - annotation - ResponseTextDeltaEvent: + - keys + ListAssistantsResponse: type: object properties: - type: + object: type: string - enum: - - response.output_text.delta - x-stainless-const: true - item_id: + data: + type: array + items: + $ref: '#/components/schemas/AssistantObject' + first_id: type: string - output_index: - type: integer - content_index: - type: integer - delta: + last_id: type: string + has_more: + type: boolean required: - - type - - item_id - - output_index - - content_index - - delta - ResponseTextDoneEvent: + - object + - data + - first_id + - last_id + - has_more + AssistantToolsCode: type: object + title: Code interpreter tool properties: type: type: string enum: - - response.output_text.done - x-stainless-const: true - item_id: - type: string - output_index: - type: integer - content_index: - type: integer - text: - type: string - required: - - type - - item_id - - output_index - - content_index - - text - ResponseUsage: - type: object - properties: - input_tokens: - type: integer - input_tokens_details: - type: object - properties: - cached_tokens: - type: integer - required: - - cached_tokens - output_tokens: - type: integer - output_tokens_details: - type: object - properties: - reasoning_tokens: - type: integer - required: - - reasoning_tokens - total_tokens: - type: integer + - code_interpreter required: - - input_tokens - - input_tokens_details - - output_tokens - - output_tokens_details - - total_tokens - ResponseWebSearchCallCompletedEvent: + - type + AssistantToolsFileSearch: type: object + title: FileSearch tool properties: type: type: string enum: - - response.web_search_call.completed - x-stainless-const: true - output_index: - type: integer - item_id: - type: string + - file_search + file_search: + type: object + properties: + max_num_results: + type: integer + minimum: 1 + maximum: 50 required: - type - - output_index - - item_id - ResponseWebSearchCallInProgressEvent: + AssistantToolsFileSearchTypeOnly: type: object + title: FileSearch tool properties: type: type: string enum: - - response.web_search_call.in_progress - x-stainless-const: true - output_index: - type: integer - item_id: - type: string + - file_search required: - type - - output_index - - item_id - ResponseWebSearchCallSearchingEvent: + AssistantToolsFunction: type: object + title: Function tool properties: type: type: string enum: - - response.web_search_call.searching - x-stainless-const: true - output_index: - type: integer - item_id: - type: string + - function + function: + $ref: '#/components/schemas/FunctionObject' required: - type - - output_index - - item_id - RunCompletionUsage: - type: object - properties: - completion_tokens: - type: integer - prompt_tokens: - type: integer - total_tokens: - type: integer - required: - - prompt_tokens - - completion_tokens - - total_tokens - nullable: true - RunStepCompletionUsage: + - function + TruncationObject: type: object + title: Thread Truncation Controls properties: - completion_tokens: - type: integer - prompt_tokens: - type: integer - total_tokens: + type: + type: string + enum: + - auto + - last_messages + last_messages: type: integer + minimum: 1 + nullable: true required: - - prompt_tokens - - completion_tokens - - total_tokens - nullable: true - AssistantsApiResponseFormatOption: + - type + AssistantsApiToolChoiceOption: oneOf: - type: string enum: - none - auto - - $ref: '#/components/schemas/AssistantsApiResponseFormat' + - required + - $ref: '#/components/schemas/AssistantsNamedToolChoice' x-oaiExpandable: true - AssistantsApiResponseFormat: + AssistantsNamedToolChoice: type: object properties: type: type: string enum: - - text - - json_object - default: text - Annotation: - oneOf: - - $ref: '#/components/schemas/FileCitation' - - $ref: '#/components/schemas/UrlCitation' - - $ref: '#/components/schemas/FilePath' - AssistantObject: + - function + - code_interpreter + - file_search + function: + type: object + properties: + name: + type: string + required: + - name + required: + - type + RunObject: type: object - title: Assistant + title: A run on a thread properties: id: type: string object: type: string enum: - - assistant + - thread.run created_at: type: integer - name: + thread_id: type: string - maxLength: 256 - nullable: true - description: + assistant_id: type: string - maxLength: 512 + status: + type: string + enum: + - queued + - in_progress + - requires_action + - cancelling + - cancelled + - failed + - completed + - incomplete + - expired + required_action: + type: object + nullable: true + properties: + type: + type: string + enum: + - submit_tool_outputs + submit_tool_outputs: + type: object + properties: + tool_calls: + type: array + items: + $ref: '#/components/schemas/RunToolCallObject' + required: + - tool_calls + required: + - type + - submit_tool_outputs + last_error: + type: object + nullable: true + properties: + code: + type: string + enum: + - server_error + - rate_limit_exceeded + - invalid_prompt + message: + type: string + required: + - code + - message + expires_at: + type: integer + nullable: true + started_at: + type: integer + nullable: true + cancelled_at: + type: integer nullable: true + failed_at: + type: integer + nullable: true + completed_at: + type: integer + nullable: true + incomplete_details: + type: object + nullable: true + properties: + reason: + type: string + enum: + - max_completion_tokens + - max_prompt_tokens model: type: string instructions: type: string - maxLength: 256000 - nullable: true tools: default: [] type: array - maxItems: 128 + maxItems: 20 items: oneOf: - $ref: '#/components/schemas/AssistantToolsCode' - $ref: '#/components/schemas/AssistantToolsFileSearch' - $ref: '#/components/schemas/AssistantToolsFunction' x-oaiExpandable: true - tool_resources: - type: object - properties: - code_interpreter: - type: object - properties: - file_ids: - type: array - default: [] - maxItems: 20 - items: - type: string - file_search: - type: object - properties: - vector_store_ids: - type: array - maxItems: 1 - items: - type: string - nullable: true metadata: type: object x-oaiTypeLabel: map nullable: true + usage: + $ref: '#/components/schemas/RunCompletionUsage' temperature: type: number - minimum: 0 - maximum: 2 - default: 1 nullable: true top_p: type: number - minimum: 0 - maximum: 1 - default: 1 nullable: true + max_prompt_tokens: + type: integer + nullable: true + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + minimum: 256 + truncation_strategy: + $ref: '#/components/schemas/TruncationObject' + nullable: true + tool_choice: + $ref: '#/components/schemas/AssistantsApiToolChoiceOption' + nullable: true + parallel_tool_calls: + $ref: '#/components/schemas/ParallelToolCalls' response_format: $ref: '#/components/schemas/AssistantsApiResponseFormatOption' nullable: true @@ -12283,16 +13787,34 @@ components: - id - object - created_at - - name - - description + - thread_id + - assistant_id + - status + - required_action + - last_error + - expires_at + - started_at + - cancelled_at + - failed_at + - completed_at - model - instructions - tools - metadata - CreateAssistantRequest: + - usage + - incomplete_details + - max_prompt_tokens + - max_completion_tokens + - truncation_strategy + - tool_choice + - parallel_tool_calls + - response_format + CreateRunRequest: type: object additionalProperties: false properties: + assistant_id: + type: string model: anyOf: - type: string @@ -12319,106 +13841,28 @@ components: - gpt-3.5-turbo-0125 - gpt-3.5-turbo-16k-0613 x-oaiTypeLabel: string - name: - type: string nullable: true - maxLength: 256 - description: + instructions: type: string nullable: true - maxLength: 512 - instructions: + additional_instructions: type: string nullable: true - maxLength: 256000 + additional_messages: + type: array + items: + $ref: '#/components/schemas/CreateMessageRequest' + nullable: true tools: - default: [] + nullable: true type: array - maxItems: 128 + maxItems: 20 items: oneOf: - $ref: '#/components/schemas/AssistantToolsCode' - $ref: '#/components/schemas/AssistantToolsFileSearch' - $ref: '#/components/schemas/AssistantToolsFunction' x-oaiExpandable: true - tool_resources: - type: object - properties: - code_interpreter: - type: object - properties: - file_ids: - type: array - default: [] - maxItems: 20 - items: - type: string - file_search: - type: object - properties: - vector_store_ids: - type: array - maxItems: 1 - items: - type: string - vector_stores: - type: array - maxItems: 1 - items: - type: object - properties: - file_ids: - type: array - maxItems: 10000 - items: - type: string - chunking_strategy: - type: object - oneOf: - - type: object - title: Auto Chunking Strategy - additionalProperties: false - properties: - type: - type: string - enum: - - auto - required: - - type - - type: object - title: Static Chunking Strategy - additionalProperties: false - properties: - type: - type: string - enum: - - static - static: - type: object - additionalProperties: false - properties: - max_chunk_size_tokens: - type: integer - minimum: 100 - maximum: 4096 - chunk_overlap_tokens: - type: integer - required: - - max_chunk_size_tokens - - chunk_overlap_tokens - required: - - type - - static - x-oaiExpandable: true - metadata: - type: object - x-oaiTypeLabel: map - oneOf: - - required: - - vector_store_ids - - required: - - vector_stores - nullable: true metadata: type: object x-oaiTypeLabel: map @@ -12435,73 +13879,212 @@ components: maximum: 1 default: 1 nullable: true + stream: + type: boolean + nullable: true + max_prompt_tokens: + type: integer + nullable: true + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + minimum: 256 + truncation_strategy: + $ref: '#/components/schemas/TruncationObject' + nullable: true + tool_choice: + $ref: '#/components/schemas/AssistantsApiToolChoiceOption' + nullable: true + parallel_tool_calls: + $ref: '#/components/schemas/ParallelToolCalls' response_format: $ref: '#/components/schemas/AssistantsApiResponseFormatOption' nullable: true required: - - model - Metadata: + - thread_id + - assistant_id + ListRunsResponse: type: object - additionalProperties: - type: string - x-oaiTypeLabel: map - nullable: true - ModelIdsResponses: - anyOf: - - type: string - enum: - - o1-pro - - o1-pro-2025-03-19 - - computer-use-preview - - computer-use-preview-2025-03-11 - ModelResponseProperties: + properties: + object: + type: string + data: + type: array + items: + $ref: '#/components/schemas/RunObject' + first_id: + type: string + last_id: + type: string + has_more: + type: boolean + required: + - object + - data + - first_id + - last_id + - has_more + ModifyRunRequest: type: object + additionalProperties: false properties: metadata: - $ref: '#/components/schemas/Metadata' - temperature: - type: number - minimum: 0 - maximum: 2 - default: 1 + type: object + x-oaiTypeLabel: map nullable: true - top_p: - type: number - minimum: 0 - maximum: 1 - default: 1 + SubmitToolOutputsRunRequest: + type: object + additionalProperties: false + properties: + tool_outputs: + type: array + items: + type: object + properties: + tool_call_id: + type: string + output: + type: string + stream: + type: boolean nullable: true - user: + required: + - tool_outputs + TextResponseFormatConfiguration: + oneOf: + - $ref: '#/components/schemas/ResponseFormatText' + - $ref: '#/components/schemas/TextResponseFormatJsonSchema' + - $ref: '#/components/schemas/ResponseFormatJsonObject' + x-oaiExpandable: true + TextResponseFormatJsonSchema: + type: object + title: JSON schema + properties: + type: + type: string + enum: + - json_schema + x-stainless-const: true + description: + type: string + name: + type: string + schema: + $ref: '#/components/schemas/ResponseFormatJsonSchemaSchema' + strict: + type: boolean + nullable: true + default: false + required: + - type + - schema + RunToolCallObject: + type: object + properties: + id: + type: string + type: + type: string + enum: + - function + function: + type: object + properties: + name: + type: string + arguments: + type: string + required: + - name + - arguments + required: + - id + - type + - function + Screenshot: + type: object + title: Screenshot + properties: + type: + type: string + enum: + - screenshot + default: screenshot + x-stainless-const: true + required: + - type + Scroll: + type: object + title: Scroll + properties: + type: type: string - ModifyAssistantRequest: + enum: + - scroll + default: scroll + x-stainless-const: true + x: + type: integer + y: + type: integer + scroll_x: + type: integer + scroll_y: + type: integer + required: + - type + - x + - y + - scroll_x + - scroll_y + CreateThreadAndRunRequest: type: object additionalProperties: false properties: + assistant_id: + type: string + thread: + $ref: '#/components/schemas/CreateThreadRequest' model: anyOf: - type: string - name: - type: string - nullable: true - maxLength: 256 - description: - type: string + - type: string + enum: + - gpt-4o + - gpt-4o-2024-05-13 + - 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 + x-oaiTypeLabel: string nullable: true - maxLength: 512 instructions: type: string nullable: true - maxLength: 256000 tools: - default: [] + nullable: true type: array - maxItems: 128 + maxItems: 20 items: oneOf: - $ref: '#/components/schemas/AssistantToolsCode' - $ref: '#/components/schemas/AssistantToolsFileSearch' - $ref: '#/components/schemas/AssistantToolsFunction' - x-oaiExpandable: true tool_resources: type: object properties: @@ -12539,458 +14122,381 @@ components: maximum: 1 default: 1 nullable: true + stream: + type: boolean + nullable: true + max_prompt_tokens: + type: integer + nullable: true + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + minimum: 256 + truncation_strategy: + $ref: '#/components/schemas/TruncationObject' + nullable: true + tool_choice: + $ref: '#/components/schemas/AssistantsApiToolChoiceOption' + nullable: true + parallel_tool_calls: + $ref: '#/components/schemas/ParallelToolCalls' response_format: $ref: '#/components/schemas/AssistantsApiResponseFormatOption' nullable: true - DeleteAssistantResponse: + required: + - thread_id + - assistant_id + ThreadObject: type: object + title: Thread properties: id: type: string - deleted: - type: boolean object: type: string enum: - - assistant.deleted + - thread + created_at: + type: integer + tool_resources: + type: object + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + maxItems: 1 + items: + type: string + nullable: true + metadata: + type: object + x-oaiTypeLabel: map + nullable: true required: - id - object - - deleted - Item: - type: object - oneOf: - - $ref: '#/components/schemas/InputMessage' - - $ref: '#/components/schemas/OutputMessage' - - $ref: '#/components/schemas/FileSearchToolCall' - - $ref: '#/components/schemas/ComputerToolCall' - - $ref: '#/components/schemas/ComputerToolCallOutput' - - $ref: '#/components/schemas/WebSearchToolCall' - - $ref: '#/components/schemas/FunctionToolCall' - - $ref: '#/components/schemas/FunctionToolCallOutput' - - $ref: '#/components/schemas/ReasoningItem' - x-oaiExpandable: true - discriminator: - propertyName: type - ItemReference: - type: object - title: Item reference - properties: - id: - type: string - type: - type: string - enum: - - item_reference - x-stainless-const: true - required: - - id - - type - ItemResource: - oneOf: - - $ref: '#/components/schemas/InputMessageResource' - - $ref: '#/components/schemas/OutputMessage' - - $ref: '#/components/schemas/FileSearchToolCall' - - $ref: '#/components/schemas/ComputerToolCall' - - $ref: '#/components/schemas/ComputerToolCallOutputResource' - - $ref: '#/components/schemas/WebSearchToolCall' - - $ref: '#/components/schemas/FunctionToolCallResource' - - $ref: '#/components/schemas/FunctionToolCallOutputResource' - x-oaiExpandable: true - discriminator: - propertyName: type - KeyPress: - type: object - title: KeyPress - properties: - type: - type: string - enum: - - keypress - default: keypress - x-stainless-const: true - keys: - type: array - items: - type: string - required: - - type - - keys - ListAssistantsResponse: + - created_at + - tool_resources + - metadata + CreateThreadRequest: type: object + additionalProperties: false properties: - object: - type: string - data: + messages: type: array items: - $ref: '#/components/schemas/AssistantObject' - first_id: - type: string - last_id: - type: string - has_more: - type: boolean - required: - - object - - data - - first_id - - last_id - - has_more - AssistantToolsCode: - type: object - title: Code interpreter tool - properties: - type: - type: string - enum: - - code_interpreter - required: - - type - AssistantToolsFileSearch: + $ref: '#/components/schemas/CreateMessageRequest' + tool_resources: + type: object + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + maxItems: 1 + items: + type: string + vector_stores: + type: array + maxItems: 1 + items: + type: object + properties: + file_ids: + type: array + maxItems: 10000 + items: + type: string + chunking_strategy: + type: object + oneOf: + - type: object + title: Auto Chunking Strategy + additionalProperties: false + properties: + type: + type: string + enum: + - auto + required: + - type + - type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + enum: + - static + static: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + chunk_overlap_tokens: + type: integer + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + required: + - type + - static + x-oaiExpandable: true + metadata: + type: object + x-oaiTypeLabel: map + x-oaiExpandable: true + oneOf: + - required: + - vector_store_ids + - required: + - vector_stores + nullable: true + metadata: + type: object + x-oaiTypeLabel: map + nullable: true + ModifyThreadRequest: type: object - title: FileSearch tool + additionalProperties: false properties: - type: - type: string - enum: - - file_search - file_search: + tool_resources: type: object properties: - max_num_results: - type: integer - minimum: 1 - maximum: 50 - required: - - type - AssistantToolsFileSearchTypeOnly: - type: object - title: FileSearch tool - properties: - type: - type: string - enum: - - file_search - required: - - type - AssistantToolsFunction: - type: object - title: Function tool - properties: - type: - type: string - enum: - - function - function: - $ref: '#/components/schemas/FunctionObject' - required: - - type - - function - TruncationObject: - type: object - title: Thread Truncation Controls - properties: - type: - type: string - enum: - - auto - - last_messages - last_messages: - type: integer - minimum: 1 + code_interpreter: + type: object + properties: + file_ids: + type: array + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + maxItems: 1 + items: + type: string nullable: true - required: - - type - AssistantsApiToolChoiceOption: - oneOf: - - type: string - enum: - - none - - auto - - required - - $ref: '#/components/schemas/AssistantsNamedToolChoice' - x-oaiExpandable: true - AssistantsNamedToolChoice: + metadata: + type: object + x-oaiTypeLabel: map + nullable: true + DeleteThreadResponse: type: object properties: - type: + id: + type: string + deleted: + type: boolean + object: type: string enum: - - function - - code_interpreter - - file_search - function: - type: object - properties: - name: - type: string - required: - - name + - thread.deleted required: - - type - RunObject: + - id + - object + - deleted + MessageObject: type: object - title: A run on a thread + title: The message object properties: id: type: string object: type: string enum: - - thread.run + - thread.message created_at: type: integer thread_id: type: string - assistant_id: - type: string status: type: string enum: - - queued - in_progress - - requires_action - - cancelling - - cancelled - - failed - - completed - incomplete - - expired - required_action: + - completed + incomplete_details: type: object - nullable: true properties: - type: + reason: type: string enum: - - submit_tool_outputs - submit_tool_outputs: - type: object - properties: - tool_calls: - type: array - items: - $ref: '#/components/schemas/RunToolCallObject' - required: - - tool_calls - required: - - type - - submit_tool_outputs - last_error: - type: object + - content_filter + - max_tokens + - run_cancelled + - run_expired + - run_failed nullable: true - properties: - code: - type: string - enum: - - server_error - - rate_limit_exceeded - - invalid_prompt - message: - type: string required: - - code - - message - expires_at: - type: integer - nullable: true - started_at: - type: integer - nullable: true - cancelled_at: - type: integer - nullable: true - failed_at: - type: integer - nullable: true + - reason completed_at: type: integer nullable: true - incomplete_details: - type: object - nullable: true - properties: - reason: - type: string - enum: - - max_completion_tokens - - max_prompt_tokens - model: - type: string - instructions: - type: string - tools: - default: [] - type: array - maxItems: 20 - items: - oneOf: - - $ref: '#/components/schemas/AssistantToolsCode' - - $ref: '#/components/schemas/AssistantToolsFileSearch' - - $ref: '#/components/schemas/AssistantToolsFunction' - x-oaiExpandable: true - metadata: - type: object - x-oaiTypeLabel: map - nullable: true - usage: - $ref: '#/components/schemas/RunCompletionUsage' - temperature: - type: number - nullable: true - top_p: - type: number - nullable: true - max_prompt_tokens: + incomplete_at: type: integer nullable: true - minimum: 256 - max_completion_tokens: - type: integer + role: + type: string + enum: + - user + - assistant + content: + type: array + items: + oneOf: + - $ref: '#/components/schemas/MessageContentImageFileObject' + - $ref: '#/components/schemas/MessageContentImageUrlObject' + - $ref: '#/components/schemas/MessageContentTextObject' + x-oaiExpandable: true + assistant_id: + type: string nullable: true - minimum: 256 - truncation_strategy: - $ref: '#/components/schemas/TruncationObject' + run_id: + type: string nullable: true - tool_choice: - $ref: '#/components/schemas/AssistantsApiToolChoiceOption' + attachments: + type: array + items: + type: object + properties: + file_id: + type: string + tools: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AssistantToolsCode' + - $ref: '#/components/schemas/AssistantToolsFileSearchTypeOnly' + x-oaiExpandable: true nullable: true - parallel_tool_calls: - $ref: '#/components/schemas/ParallelToolCalls' - response_format: - $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + metadata: + type: object + x-oaiTypeLabel: map nullable: true required: - id - object - created_at - thread_id - - assistant_id - status - - required_action - - last_error - - expires_at - - started_at - - cancelled_at - - failed_at + - incomplete_details - completed_at - - model - - instructions - - tools + - incomplete_at + - role + - content + - assistant_id + - run_id + - attachments - metadata - - usage - - incomplete_details - - max_prompt_tokens - - max_completion_tokens - - truncation_strategy - - tool_choice - - parallel_tool_calls - - response_format - CreateRunRequest: + CreateMessageRequest: type: object additionalProperties: false + required: + - role + - content properties: - assistant_id: + role: type: string - model: - anyOf: - - type: string + enum: + - user + - assistant + content: + oneOf: - type: string - enum: - - gpt-4o - - gpt-4o-2024-05-13 - - 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 - x-oaiTypeLabel: string - nullable: true - instructions: - type: string - nullable: true - additional_instructions: - type: string - nullable: true - additional_messages: + title: Text content + - type: array + title: Array of content parts + items: + oneOf: + - $ref: '#/components/schemas/MessageContentImageFileObject' + - $ref: '#/components/schemas/MessageContentImageUrlObject' + - $ref: '#/components/schemas/MessageRequestContentTextObject' + x-oaiExpandable: true + minItems: 1 + x-oaiExpandable: true + attachments: type: array items: - $ref: '#/components/schemas/CreateMessageRequest' - nullable: true - tools: + type: object + properties: + file_id: + type: string + tools: + type: array + items: + oneOf: + - $ref: '#/components/schemas/AssistantToolsCode' + - $ref: '#/components/schemas/AssistantToolsFileSearchTypeOnly' + x-oaiExpandable: true + required: + - file_id + - tools nullable: true - type: array - maxItems: 20 - items: - oneOf: - - $ref: '#/components/schemas/AssistantToolsCode' - - $ref: '#/components/schemas/AssistantToolsFileSearch' - - $ref: '#/components/schemas/AssistantToolsFunction' - x-oaiExpandable: true metadata: type: object x-oaiTypeLabel: map nullable: true - temperature: - type: number - minimum: 0 - maximum: 2 - default: 1 - nullable: true - top_p: - type: number - minimum: 0 - maximum: 1 - default: 1 + ModifyMessageRequest: + type: object + additionalProperties: false + properties: + metadata: + type: object + x-oaiTypeLabel: map nullable: true - stream: + DeleteMessageResponse: + type: object + properties: + id: + type: string + deleted: type: boolean - nullable: true - max_prompt_tokens: - type: integer - nullable: true - minimum: 256 - max_completion_tokens: - type: integer - nullable: true - minimum: 256 - truncation_strategy: - $ref: '#/components/schemas/TruncationObject' - nullable: true - tool_choice: - $ref: '#/components/schemas/AssistantsApiToolChoiceOption' - nullable: true - parallel_tool_calls: - $ref: '#/components/schemas/ParallelToolCalls' - response_format: - $ref: '#/components/schemas/AssistantsApiResponseFormatOption' - nullable: true + object: + type: string + enum: + - thread.message.deleted required: - - thread_id - - assistant_id - ListRunsResponse: - type: object + - id + - object + - deleted + ListMessagesResponse: properties: object: type: string data: type: array items: - $ref: '#/components/schemas/RunObject' + $ref: '#/components/schemas/MessageObject' first_id: type: string last_id: @@ -13003,480 +14509,470 @@ components: - first_id - last_id - has_more - ModifyRunRequest: + MessageContentImageFileObject: + title: Image file type: object - additionalProperties: false properties: - metadata: + type: + type: string + enum: + - image_file + image_file: type: object - x-oaiTypeLabel: map - nullable: true - SubmitToolOutputsRunRequest: - type: object - additionalProperties: false - properties: - tool_outputs: - type: array - items: - type: object - properties: - tool_call_id: - type: string - output: - type: string - stream: - type: boolean - nullable: true + properties: + file_id: + type: string + detail: + type: string + enum: + - auto + - low + - high + default: auto + required: + - file_id required: - - tool_outputs - TextResponseFormatConfiguration: - oneOf: - - $ref: '#/components/schemas/ResponseFormatText' - - $ref: '#/components/schemas/TextResponseFormatJsonSchema' - - $ref: '#/components/schemas/ResponseFormatJsonObject' - x-oaiExpandable: true - TextResponseFormatJsonSchema: + - type + - image_file + MessageContentImageUrlObject: + title: Image URL type: object - title: JSON schema properties: type: type: string enum: - - json_schema - x-stainless-const: true - description: - type: string - name: - type: string - schema: - $ref: '#/components/schemas/ResponseFormatJsonSchemaSchema' - strict: - type: boolean - nullable: true - default: false + - image_url + image_url: + type: object + properties: + url: + type: string + format: uri + detail: + type: string + enum: + - auto + - low + - high + default: auto + required: + - url required: - type - - schema - RunToolCallObject: + - image_url + MessageContentTextObject: + title: Text type: object properties: - id: - type: string type: type: string enum: - - function - function: + - text + text: type: object properties: - name: - type: string - arguments: + value: type: string + annotations: + type: array + items: + oneOf: + - $ref: '#/components/schemas/MessageContentTextAnnotationsFileCitationObject' + - $ref: '#/components/schemas/MessageContentTextAnnotationsFilePathObject' + x-oaiExpandable: true required: - - name - - arguments + - value + - annotations required: - - id - type - - function - Screenshot: + - text + MessageRequestContentTextObject: + title: Text type: object - title: Screenshot properties: type: type: string enum: - - screenshot - default: screenshot - x-stainless-const: true + - text + text: + type: string required: - type - Scroll: + - text + MessageContentTextAnnotationsFileCitationObject: + title: File citation type: object - title: Scroll properties: type: type: string enum: - - scroll - default: scroll - x-stainless-const: true - x: + - file_citation + text: + type: string + file_citation: + type: object + properties: + file_id: + type: string + quote: + type: string + required: + - file_id + - quote + start_index: type: integer - y: + minimum: 0 + end_index: type: integer - scroll_x: + minimum: 0 + required: + - type + - text + - file_citation + - start_index + - end_index + MessageContentTextAnnotationsFilePathObject: + title: File path + type: object + properties: + type: + type: string + enum: + - file_path + text: + type: string + file_path: + type: object + properties: + file_id: + type: string + required: + - file_id + start_index: type: integer - scroll_y: + minimum: 0 + end_index: type: integer + minimum: 0 required: - type - - x - - y - - scroll_x - - scroll_y - CreateThreadAndRunRequest: + - text + - file_path + - start_index + - end_index + RunStepObject: type: object - additionalProperties: false + title: Run steps properties: + id: + type: string + object: + type: string + enum: + - thread.run.step + created_at: + type: integer assistant_id: type: string - thread: - $ref: '#/components/schemas/CreateThreadRequest' - model: - anyOf: - - type: string - - type: string - enum: - - gpt-4o - - gpt-4o-2024-05-13 - - 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 - x-oaiTypeLabel: string - nullable: true - instructions: + thread_id: type: string - nullable: true - tools: - nullable: true - type: array - maxItems: 20 - items: - oneOf: - - $ref: '#/components/schemas/AssistantToolsCode' - - $ref: '#/components/schemas/AssistantToolsFileSearch' - - $ref: '#/components/schemas/AssistantToolsFunction' - tool_resources: + run_id: + type: string + type: + type: string + enum: + - message_creation + - tool_calls + status: + type: string + enum: + - in_progress + - cancelled + - failed + - completed + - expired + step_details: type: object - properties: - code_interpreter: - type: object - properties: - file_ids: - type: array - default: [] - maxItems: 20 - items: - type: string - file_search: - type: object - properties: - vector_store_ids: - type: array - maxItems: 1 - items: - type: string - nullable: true - metadata: + oneOf: + - $ref: '#/components/schemas/RunStepDetailsMessageCreationObject' + - $ref: '#/components/schemas/RunStepDetailsToolCallsObject' + x-oaiExpandable: true + last_error: type: object - x-oaiTypeLabel: map - nullable: true - temperature: - type: number - minimum: 0 - maximum: 2 - default: 1 - nullable: true - top_p: - type: number - minimum: 0 - maximum: 1 - default: 1 - nullable: true - stream: - type: boolean nullable: true - max_prompt_tokens: + properties: + code: + type: string + enum: + - server_error + - rate_limit_exceeded + message: + type: string + required: + - code + - message + expired_at: type: integer nullable: true - minimum: 256 - max_completion_tokens: + cancelled_at: type: integer nullable: true - minimum: 256 - truncation_strategy: - $ref: '#/components/schemas/TruncationObject' - nullable: true - tool_choice: - $ref: '#/components/schemas/AssistantsApiToolChoiceOption' - nullable: true - parallel_tool_calls: - $ref: '#/components/schemas/ParallelToolCalls' - response_format: - $ref: '#/components/schemas/AssistantsApiResponseFormatOption' + failed_at: + type: integer nullable: true - required: - - thread_id - - assistant_id - ThreadObject: - type: object - title: Thread - properties: - id: - type: string - object: - type: string - enum: - - thread - created_at: + completed_at: type: integer - tool_resources: - type: object - properties: - code_interpreter: - type: object - properties: - file_ids: - type: array - default: [] - maxItems: 20 - items: - type: string - file_search: - type: object - properties: - vector_store_ids: - type: array - maxItems: 1 - items: - type: string nullable: true metadata: type: object x-oaiTypeLabel: map nullable: true + usage: + $ref: '#/components/schemas/RunStepCompletionUsage' required: - id - object - created_at - - tool_resources + - assistant_id + - thread_id + - run_id + - type + - status + - step_details + - last_error + - expired_at + - cancelled_at + - failed_at + - completed_at - metadata - CreateThreadRequest: - type: object - additionalProperties: false + - usage + ListRunStepsResponse: properties: - messages: + object: + type: string + data: type: array items: - $ref: '#/components/schemas/CreateMessageRequest' - tool_resources: + $ref: '#/components/schemas/RunStepObject' + first_id: + type: string + last_id: + type: string + has_more: + type: boolean + required: + - object + - data + - first_id + - last_id + - has_more + RunStepDetailsMessageCreationObject: + title: Message creation + type: object + properties: + type: + type: string + enum: + - message_creation + message_creation: type: object properties: - code_interpreter: - type: object - properties: - file_ids: - type: array - default: [] - maxItems: 20 - items: - type: string - file_search: - type: object - properties: - vector_store_ids: - type: array - maxItems: 1 - items: - type: string - vector_stores: - type: array - maxItems: 1 - items: - type: object - properties: - file_ids: - type: array - maxItems: 10000 - items: - type: string - chunking_strategy: - type: object - oneOf: - - type: object - title: Auto Chunking Strategy - additionalProperties: false - properties: - type: - type: string - enum: - - auto - required: - - type - - type: object - title: Static Chunking Strategy - additionalProperties: false - properties: - type: - type: string - enum: - - static - static: - type: object - additionalProperties: false - properties: - max_chunk_size_tokens: - type: integer - minimum: 100 - maximum: 4096 - chunk_overlap_tokens: - type: integer - required: - - max_chunk_size_tokens - - chunk_overlap_tokens - required: - - type - - static - x-oaiExpandable: true - metadata: - type: object - x-oaiTypeLabel: map - x-oaiExpandable: true - oneOf: - - required: - - vector_store_ids - - required: - - vector_stores - nullable: true - metadata: + message_id: + type: string + required: + - message_id + required: + - type + - message_creation + RunStepDetailsToolCallsObject: + title: Tool calls + type: object + properties: + type: + type: string + enum: + - tool_calls + tool_calls: + type: array + items: + oneOf: + - $ref: '#/components/schemas/RunStepDetailsToolCallsCodeObject' + - $ref: '#/components/schemas/RunStepDetailsToolCallsFileSearchObject' + - $ref: '#/components/schemas/RunStepDetailsToolCallsFunctionObject' + x-oaiExpandable: true + required: + - type + - tool_calls + RunStepDetailsToolCallsCodeObject: + title: Code Interpreter tool call + type: object + properties: + id: + type: string + type: + type: string + enum: + - code_interpreter + code_interpreter: type: object - x-oaiTypeLabel: map - nullable: true - ModifyThreadRequest: + required: + - input + - outputs + properties: + input: + type: string + outputs: + type: array + items: + type: object + oneOf: + - $ref: '#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject' + - $ref: '#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject' + x-oaiExpandable: true + required: + - id + - type + - code_interpreter + RunStepDetailsToolCallsCodeOutputLogsObject: + title: Code Interpreter log output type: object - additionalProperties: false properties: - tool_resources: + type: + type: string + enum: + - logs + logs: + type: string + required: + - type + - logs + RunStepDetailsToolCallsCodeOutputImageObject: + title: Code Interpreter image output + type: object + properties: + type: + type: string + enum: + - image + image: type: object properties: - code_interpreter: - type: object - properties: - file_ids: - type: array - default: [] - maxItems: 20 - items: - type: string - file_search: - type: object - properties: - vector_store_ids: - type: array - maxItems: 1 - items: - type: string - nullable: true - metadata: + file_id: + type: string + required: + - file_id + required: + - type + - image + RunStepDetailsToolCallsFileSearchObject: + title: File search tool call + type: object + properties: + id: + type: string + type: + type: string + enum: + - file_search + file_search: type: object x-oaiTypeLabel: map - nullable: true - DeleteThreadResponse: + required: + - id + - type + - file_search + RunStepDetailsToolCallsFunctionObject: type: object + title: Function tool call properties: id: type: string - deleted: - type: boolean - object: + type: type: string enum: - - thread.deleted + - function + function: + type: object + properties: + name: + type: string + arguments: + type: string + output: + type: string + nullable: true + required: + - name + - arguments + - output required: - id - - object - - deleted - MessageObject: + - type + - function + VectorStoreExpirationAfter: type: object - title: The message object + title: Vector store expiration policy + properties: + anchor: + type: string + enum: + - last_active_at + days: + type: integer + minimum: 1 + maximum: 365 + required: + - anchor + - days + VectorStoreObject: + type: object + title: Vector store properties: id: type: string object: type: string enum: - - thread.message + - vector_store created_at: type: integer - thread_id: + name: type: string + usage_bytes: + type: integer + file_counts: + type: object + properties: + in_progress: + type: integer + completed: + type: integer + failed: + type: integer + cancelled: + type: integer + total: + type: integer + required: + - in_progress + - completed + - failed + - cancelled + - total status: type: string enum: + - expired - in_progress - - incomplete - completed - incomplete_details: - type: object - properties: - reason: - type: string - enum: - - content_filter - - max_tokens - - run_cancelled - - run_expired - - run_failed - nullable: true - required: - - reason - completed_at: + expires_after: + $ref: '#/components/schemas/VectorStoreExpirationAfter' + expires_at: type: integer nullable: true - incomplete_at: + last_active_at: type: integer nullable: true - role: - type: string - enum: - - user - - assistant - content: - type: array - items: - oneOf: - - $ref: '#/components/schemas/MessageContentImageFileObject' - - $ref: '#/components/schemas/MessageContentImageUrlObject' - - $ref: '#/components/schemas/MessageContentTextObject' - x-oaiExpandable: true - assistant_id: - type: string - nullable: true - run_id: - type: string - nullable: true - attachments: - type: array - items: - type: object - properties: - file_id: - type: string - tools: - type: array - items: - oneOf: - - $ref: '#/components/schemas/AssistantToolsCode' - - $ref: '#/components/schemas/AssistantToolsFileSearchTypeOnly' - x-oaiExpandable: true - nullable: true metadata: type: object x-oaiTypeLabel: map @@ -13484,297 +14980,225 @@ components: required: - id - object + - usage_bytes - created_at - - thread_id - status - - incomplete_details - - completed_at - - incomplete_at - - role - - content - - assistant_id - - run_id - - attachments + - last_active_at + - name + - file_counts - metadata - CreateMessageRequest: - type: object - additionalProperties: false - required: - - role - - content - properties: - role: - type: string - enum: - - user - - assistant - content: - oneOf: - - type: string - title: Text content - - type: array - title: Array of content parts - items: - oneOf: - - $ref: '#/components/schemas/MessageContentImageFileObject' - - $ref: '#/components/schemas/MessageContentImageUrlObject' - - $ref: '#/components/schemas/MessageRequestContentTextObject' - x-oaiExpandable: true - minItems: 1 - x-oaiExpandable: true - attachments: - type: array - items: - type: object - properties: - file_id: - type: string - tools: - type: array - items: - oneOf: - - $ref: '#/components/schemas/AssistantToolsCode' - - $ref: '#/components/schemas/AssistantToolsFileSearchTypeOnly' - x-oaiExpandable: true - required: - - file_id - - tools - nullable: true - metadata: - type: object - x-oaiTypeLabel: map - nullable: true - ModifyMessageRequest: - type: object - additionalProperties: false - properties: - metadata: - type: object - x-oaiTypeLabel: map - nullable: true - DeleteMessageResponse: + Wait: type: object + title: Wait properties: - id: - type: string - deleted: - type: boolean - object: + type: type: string enum: - - thread.message.deleted + - wait + default: wait + x-stainless-const: true required: - - id - - object - - deleted - ListMessagesResponse: + - type + WebSearchContextSize: + type: string + enum: + - low + - medium + - high + default: medium + WebSearchLocation: + type: object + title: Web search location properties: - object: + country: type: string - data: - type: array - items: - $ref: '#/components/schemas/MessageObject' - first_id: + region: type: string - last_id: + city: type: string - has_more: - type: boolean - required: - - object - - data - - first_id - - last_id - - has_more - MessageContentImageFileObject: - title: Image file + timezone: + type: string + WebSearchTool: type: object + title: Web search properties: type: type: string enum: - - image_file - image_file: - type: object - properties: - file_id: - type: string - detail: - type: string - enum: - - auto - - low - - high - default: auto - required: - - file_id + - web_search_preview + - web_search_preview_2025_03_11 + user_location: + allOf: + - $ref: '#/components/schemas/WebSearchLocation' + - type: object + properties: + type: + type: string + enum: + - approximate + x-stainless-const: true + required: + - type + nullable: true + search_context_size: + $ref: '#/components/schemas/WebSearchContextSize' required: - type - - image_file - MessageContentImageUrlObject: - title: Image URL + WebSearchToolCall: type: object + title: Web search tool call properties: + id: + type: string type: type: string enum: - - image_url - image_url: - type: object - properties: - url: - type: string - format: uri - detail: - type: string - enum: - - auto - - low - - high - default: auto - required: - - url + - web_search_call + x-stainless-const: true + status: + type: string + enum: + - in_progress + - searching + - completed + - failed required: + - id - type - - image_url - MessageContentTextObject: - title: Text + - status + CreateVectorStoreRequest: type: object + additionalProperties: false properties: - type: + file_ids: + type: array + maxItems: 500 + items: + type: string + name: type: string - enum: - - text - text: + expires_after: + $ref: '#/components/schemas/VectorStoreExpirationAfter' + chunking_strategy: type: object - properties: - value: - type: string - annotations: - type: array - items: - oneOf: - - $ref: '#/components/schemas/MessageContentTextAnnotationsFileCitationObject' - - $ref: '#/components/schemas/MessageContentTextAnnotationsFilePathObject' - x-oaiExpandable: true - required: - - value - - annotations - required: - - type - - text - MessageRequestContentTextObject: - title: Text + oneOf: + - $ref: '#/components/schemas/AutoChunkingStrategyRequestParam' + - $ref: '#/components/schemas/StaticChunkingStrategyRequestParam' + x-oaiExpandable: true + metadata: + type: object + x-oaiTypeLabel: map + nullable: true + Type: type: object + title: Type properties: type: type: string enum: - - text + - type + default: type + x-stainless-const: true text: type: string required: - type - text - MessageContentTextAnnotationsFileCitationObject: - title: File citation + UpdateVectorStoreRequest: type: object + additionalProperties: false properties: - type: - type: string - enum: - - file_citation - text: + name: type: string - file_citation: + nullable: true + expires_after: + $ref: '#/components/schemas/VectorStoreExpirationAfter' + nullable: true + metadata: type: object - properties: - file_id: - type: string - quote: - type: string - required: - - file_id - - quote - start_index: - type: integer - minimum: 0 - end_index: - type: integer - minimum: 0 - required: - - type - - text - - file_citation - - start_index - - end_index - MessageContentTextAnnotationsFilePathObject: - title: File path + x-oaiTypeLabel: map + nullable: true + UrlCitation: type: object + title: URL citation properties: + url: + type: string + title: + type: string type: type: string enum: - - file_path - text: - type: string - file_path: - type: object - properties: - file_id: - type: string - required: - - file_id + - url_citation + x-stainless-const: true start_index: type: integer - minimum: 0 end_index: type: integer - minimum: 0 required: + - url + - title - type - - text - - file_path - start_index - end_index - RunStepObject: + ListVectorStoresResponse: + properties: + object: + type: string + data: + type: array + items: + $ref: '#/components/schemas/VectorStoreObject' + first_id: + type: string + last_id: + type: string + has_more: + type: boolean + required: + - object + - data + - first_id + - last_id + - has_more + DeleteVectorStoreResponse: type: object - title: Run steps properties: id: type: string + deleted: + type: boolean object: type: string enum: - - thread.run.step - created_at: - type: integer - assistant_id: - type: string - thread_id: - type: string - run_id: + - vector_store.deleted + required: + - id + - object + - deleted + VectorStoreFileObject: + type: object + title: Vector store files + properties: + id: type: string - type: + object: type: string enum: - - message_creation - - tool_calls + - vector_store.file + usage_bytes: + type: integer + created_at: + type: integer + vector_store_id: + type: string status: type: string enum: - in_progress + - completed - cancelled - failed - - completed - - expired - step_details: - type: object - oneOf: - - $ref: '#/components/schemas/RunStepDetailsMessageCreationObject' - - $ref: '#/components/schemas/RunStepDetailsToolCallsObject' - x-oaiExpandable: true last_error: type: object nullable: true @@ -13782,242 +15206,175 @@ components: code: type: string enum: - - server_error - - rate_limit_exceeded + - internal_error + - file_not_found + - parsing_error + - unhandled_mime_type message: type: string required: - code - message - expired_at: - type: integer - nullable: true - cancelled_at: - type: integer - nullable: true - failed_at: - type: integer - nullable: true - completed_at: - type: integer - nullable: true - metadata: + chunking_strategy: type: object - x-oaiTypeLabel: map - nullable: true - usage: - $ref: '#/components/schemas/RunStepCompletionUsage' + oneOf: + - $ref: '#/components/schemas/StaticChunkingStrategyResponseParam' + - $ref: '#/components/schemas/OtherChunkingStrategyResponseParam' + x-oaiExpandable: true required: - id - object + - usage_bytes - created_at - - assistant_id - - thread_id - - run_id - - type + - vector_store_id - status - - step_details - last_error - - expired_at - - cancelled_at - - failed_at - - completed_at - - metadata - - usage - ListRunStepsResponse: - properties: - object: - type: string - data: - type: array - items: - $ref: '#/components/schemas/RunStepObject' - first_id: - type: string - last_id: - type: string - has_more: - type: boolean - required: - - object - - data - - first_id - - last_id - - has_more - RunStepDetailsMessageCreationObject: - title: Message creation + OtherChunkingStrategyResponseParam: type: object + title: Other Chunking Strategy + additionalProperties: false properties: type: type: string enum: - - message_creation - message_creation: - type: object - properties: - message_id: - type: string - required: - - message_id + - other required: - type - - message_creation - RunStepDetailsToolCallsObject: - title: Tool calls + StaticChunkingStrategyResponseParam: type: object + title: Static Chunking Strategy + additionalProperties: false properties: type: type: string enum: - - tool_calls - tool_calls: - type: array - items: - oneOf: - - $ref: '#/components/schemas/RunStepDetailsToolCallsCodeObject' - - $ref: '#/components/schemas/RunStepDetailsToolCallsFileSearchObject' - - $ref: '#/components/schemas/RunStepDetailsToolCallsFunctionObject' - x-oaiExpandable: true + - static + static: + $ref: '#/components/schemas/StaticChunkingStrategy' required: - type - - tool_calls - RunStepDetailsToolCallsCodeObject: - title: Code Interpreter tool call + - static + StaticChunkingStrategy: type: object + additionalProperties: false properties: - id: - type: string - type: - type: string - enum: - - code_interpreter - code_interpreter: - type: object - required: - - input - - outputs - properties: - input: - type: string - outputs: - type: array - items: - type: object - oneOf: - - $ref: '#/components/schemas/RunStepDetailsToolCallsCodeOutputLogsObject' - - $ref: '#/components/schemas/RunStepDetailsToolCallsCodeOutputImageObject' - x-oaiExpandable: true + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + chunk_overlap_tokens: + type: integer required: - - id - - type - - code_interpreter - RunStepDetailsToolCallsCodeOutputLogsObject: - title: Code Interpreter log output + - max_chunk_size_tokens + - chunk_overlap_tokens + AutoChunkingStrategyRequestParam: type: object + title: Auto Chunking Strategy + additionalProperties: false properties: type: type: string enum: - - logs - logs: - type: string + - auto required: - type - - logs - RunStepDetailsToolCallsCodeOutputImageObject: - title: Code Interpreter image output + StaticChunkingStrategyRequestParam: type: object + title: Static Chunking Strategy + additionalProperties: false properties: type: type: string enum: - - image - image: - type: object - properties: - file_id: - type: string - required: - - file_id + - static + static: + $ref: '#/components/schemas/StaticChunkingStrategy' required: - type - - image - RunStepDetailsToolCallsFileSearchObject: - title: File search tool call + - static + ChunkingStrategyRequestParam: + type: object + oneOf: + - $ref: '#/components/schemas/AutoChunkingStrategyRequestParam' + - $ref: '#/components/schemas/StaticChunkingStrategyRequestParam' + x-oaiExpandable: true + CreateVectorStoreFileRequest: type: object + additionalProperties: false properties: - id: - type: string - type: + file_id: type: string - enum: - - file_search - file_search: - type: object - x-oaiTypeLabel: map + chunking_strategy: + $ref: '#/components/schemas/ChunkingStrategyRequestParam' required: - - id - - type - - file_search - RunStepDetailsToolCallsFunctionObject: - type: object - title: Function tool call + - file_id + ListVectorStoreFilesResponse: properties: - id: + object: type: string - type: + data: + type: array + items: + $ref: '#/components/schemas/VectorStoreFileObject' + first_id: type: string - enum: - - function - function: - type: object - properties: - name: - type: string - arguments: - type: string - output: - type: string - nullable: true - required: - - name - - arguments - - output + last_id: + type: string + has_more: + type: boolean required: - - id - - type - - function - VectorStoreExpirationAfter: + - object + - data + - first_id + - last_id + - has_more + DeleteVectorStoreFileResponse: type: object - title: Vector store expiration policy properties: - anchor: + id: + type: string + deleted: + type: boolean + object: type: string enum: - - last_active_at - days: - type: integer - minimum: 1 - maximum: 365 + - vector_store.file.deleted required: - - anchor - - days - VectorStoreObject: + - id + - object + - deleted + VectorStoreFileAttributes: type: object - title: Vector store + maxProperties: 16 + additionalProperties: + oneOf: + - type: string + maxLength: 512 + - type: number + - type: boolean + x-oaiTypeLabel: map + nullable: true + VectorStoreFileBatchObject: + type: object + title: Vector store file batch properties: id: type: string object: type: string enum: - - vector_store + - vector_store.files_batch created_at: type: integer - name: + vector_store_id: type: string - usage_bytes: - type: integer + status: + type: string + enum: + - in_progress + - completed + - cancelled + - failed file_counts: type: object properties: @@ -14034,4462 +15391,4759 @@ components: required: - in_progress - completed - - failed - cancelled + - failed - total - status: - type: string - enum: - - expired - - in_progress - - completed - expires_after: - $ref: '#/components/schemas/VectorStoreExpirationAfter' - expires_at: - type: integer - nullable: true - last_active_at: - type: integer - nullable: true - metadata: - type: object - x-oaiTypeLabel: map - nullable: true required: - id - object - - usage_bytes - created_at + - vector_store_id - status - - last_active_at - - name - file_counts - - metadata - Wait: + CreateVectorStoreFileBatchRequest: type: object - title: Wait + additionalProperties: false + properties: + file_ids: + type: array + minItems: 1 + maxItems: 500 + items: + type: string + chunking_strategy: + $ref: '#/components/schemas/ChunkingStrategyRequestParam' + required: + - file_ids + Tool: + oneOf: + - $ref: '#/components/schemas/FileSearchTool' + - $ref: '#/components/schemas/FunctionTool' + - $ref: '#/components/schemas/ComputerTool' + - $ref: '#/components/schemas/WebSearchTool' + x-oaiExpandable: true + ToolChoiceFunction: + type: object + title: Function tool properties: type: type: string enum: - - wait - default: wait + - function x-stainless-const: true + name: + type: string required: - type - WebSearchContextSize: + - name + ToolChoiceOptions: type: string + title: Tool choice mode enum: - - low - - medium - - high - default: medium - WebSearchLocation: + - none + - auto + - required + ToolChoiceTypes: type: object - title: Web search location + title: Hosted tool properties: - country: - type: string - region: + type: type: string - city: + enum: + - file_search + - web_search_preview + - computer_use_preview + - web_search_preview_2025_03_11 + required: + - type + FileCitation: + type: object + title: File citation + properties: + type: type: string - timezone: + enum: + - file_citation + x-stainless-const: true + index: + type: integer + file_id: type: string - WebSearchTool: + required: + - type + - index + - file_id + FilePath: type: object - title: Web search + title: File path properties: type: type: string enum: - - web_search_preview - - web_search_preview_2025_03_11 - user_location: - allOf: - - $ref: '#/components/schemas/WebSearchLocation' - - type: object - properties: - type: - type: string - enum: - - approximate - x-stainless-const: true - required: - - type - nullable: true - search_context_size: - $ref: '#/components/schemas/WebSearchContextSize' + - file_path + x-stainless-const: true + file_id: + type: string + index: + type: integer required: - type - WebSearchToolCall: + - file_id + - index + Batch: type: object - title: Web search tool call properties: id: type: string - type: + object: type: string enum: - - web_search_call - x-stainless-const: true + - batch + endpoint: + type: string + errors: + type: object + properties: + object: + type: string + data: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + param: + type: string + nullable: true + line: + type: integer + nullable: true + input_file_id: + type: string + completion_window: + type: string status: type: string enum: + - validating + - failed - in_progress - - searching + - finalizing - completed - - failed - required: - - id - - type - - status - CreateVectorStoreRequest: - type: object - additionalProperties: false - properties: - file_ids: - type: array - maxItems: 500 - items: - type: string - name: + - expired + - cancelling + - cancelled + output_file_id: type: string - expires_after: - $ref: '#/components/schemas/VectorStoreExpirationAfter' - chunking_strategy: + error_file_id: + type: string + created_at: + type: integer + in_progress_at: + type: integer + expires_at: + type: integer + finalizing_at: + type: integer + completed_at: + type: integer + failed_at: + type: integer + expired_at: + type: integer + cancelling_at: + type: integer + cancelled_at: + type: integer + request_counts: type: object - oneOf: - - $ref: '#/components/schemas/AutoChunkingStrategyRequestParam' - - $ref: '#/components/schemas/StaticChunkingStrategyRequestParam' - x-oaiExpandable: true + properties: + total: + type: integer + completed: + type: integer + failed: + type: integer + required: + - total + - completed + - failed metadata: type: object x-oaiTypeLabel: map nullable: true - Type: - type: object - title: Type - properties: - type: - type: string - enum: - - type - default: type - x-stainless-const: true - text: - type: string required: - - type - - text - UpdateVectorStoreRequest: - type: object - additionalProperties: false - properties: - name: - type: string - nullable: true - expires_after: - $ref: '#/components/schemas/VectorStoreExpirationAfter' - nullable: true - metadata: - type: object - x-oaiTypeLabel: map - nullable: true - UrlCitation: + - id + - object + - endpoint + - input_file_id + - completion_window + - status + - created_at + ListBatchesResponse: type: object - title: URL citation - properties: - url: - type: string - title: - type: string - type: - type: string - enum: - - url_citation - x-stainless-const: true - start_index: - type: integer - end_index: - type: integer - required: - - url - - title - - type - - start_index - - end_index - ListVectorStoresResponse: properties: - object: - type: string data: type: array items: - $ref: '#/components/schemas/VectorStoreObject' + $ref: '#/components/schemas/Batch' first_id: type: string last_id: type: string has_more: type: boolean + object: + type: string + enum: + - list required: - object - data - - first_id - - last_id - has_more - DeleteVectorStoreResponse: + FeedbackRequest: type: object + required: + - trace_id + - value properties: - id: + trace_id: type: string - deleted: - type: boolean - object: + value: + type: integer + minimum: -10 + maximum: 10 + weight: + type: number + format: float + minimum: 0 + maximum: 1 + default: 1.0 + metadata: + type: object + additionalProperties: true + FeedbackResponse: + type: object + properties: + status: type: string - enum: - - vector_store.deleted + message: + type: string + feedback_ids: + type: array + items: + type: string + FeedbackUpdateRequest: + type: object required: - - id - - object - - deleted - VectorStoreFileObject: + - value + properties: + value: + type: integer + minimum: -10 + maximum: 10 + weight: + type: number + format: float + minimum: 0 + maximum: 1 + default: 1.0 + metadata: + type: object + additionalProperties: true + RateLimits: type: object - title: Vector store files properties: - id: + type: type: string - object: + enum: + - requests + - tokens + unit: type: string enum: - - vector_store.file - usage_bytes: + - rpd + - rph + - rpm + value: type: integer - created_at: + UsageLimits: + type: object + properties: + credit_limit: type: integer - vector_store_id: + minimum: 1 + type: type: string - status: + enum: + - cost + - tokens + alert_threshold: + type: integer + minimum: 1 + periodic_reset: type: string enum: - - in_progress - - completed - - cancelled - - failed - last_error: - type: object + - monthly + - weekly nullable: true - properties: - code: - type: string - enum: - - internal_error - - file_not_found - - parsing_error - - unhandled_mime_type - message: - type: string - required: - - code - - message - chunking_strategy: - type: object - oneOf: - - $ref: '#/components/schemas/StaticChunkingStrategyResponseParam' - - $ref: '#/components/schemas/OtherChunkingStrategyResponseParam' - x-oaiExpandable: true - required: - - id - - object - - usage_bytes - - created_at - - vector_store_id - - status - - last_error - OtherChunkingStrategyResponseParam: + periodic_reset_days: + type: integer + minimum: 1 + maximum: 365 + nullable: true + next_usage_reset_at: + type: string + format: date-time + nullable: true + CreateIntegrationRequest: type: object - title: Other Chunking Strategy - additionalProperties: false + required: + - name + - ai_provider_id properties: - type: + name: + type: string + slug: + type: string + pattern: ^[a-zA-Z0-9_-]+$ + ai_provider_id: + type: string + key: + type: string + description: + type: string + workspace_id: + type: string + configurations: + type: object + oneOf: + - $ref: '#/components/schemas/OpenAIConfiguration' + title: OpenAI + - title: Anthropic + allOf: + - $ref: '#/components/schemas/AnthropicConfiguration' + - $ref: '#/components/schemas/AzureOpenAIConfiguration' + title: Azure OpenAI + - $ref: '#/components/schemas/BedrockConfiguration' + title: AWS Bedrock + - $ref: '#/components/schemas/VertexAIConfiguration' + title: Vertex AI + - $ref: '#/components/schemas/AzureAIConfiguration' + title: Azure AI + - $ref: '#/components/schemas/WorkersAIConfiguration' + title: Workers AI + - $ref: '#/components/schemas/SageMakerConfiguration' + title: AWS Sagemaker + - $ref: '#/components/schemas/HuggingFaceConfiguration' + title: Hugginface + - $ref: '#/components/schemas/CortexConfiguration' + title: Cortex + - $ref: '#/components/schemas/CustomHostConfiguration' + title: Custom Base URL + tags: + type: object + additionalProperties: + type: string + nullable: true + description: '' + create_default_provider: + type: boolean + default: true + default_provider_slug: type: string - enum: - - other - required: - - type - StaticChunkingStrategyResponseParam: + pattern: ^[a-zA-Z0-9_-]+$ + maxLength: 255 + secret_mappings: + type: array + items: + $ref: '#/components/schemas/SecretMapping' + pricing_adjustments: + $ref: '#/components/schemas/PricingAdjustments' + UpdateIntegrationRequest: type: object - title: Static Chunking Strategy - additionalProperties: false properties: - type: + name: type: string - enum: - - static - static: - $ref: '#/components/schemas/StaticChunkingStrategy' - required: - - type - - static - StaticChunkingStrategy: - type: object - additionalProperties: false - properties: - max_chunk_size_tokens: - type: integer - minimum: 100 - maximum: 4096 - chunk_overlap_tokens: - type: integer - required: - - max_chunk_size_tokens - - chunk_overlap_tokens - AutoChunkingStrategyRequestParam: - type: object - title: Auto Chunking Strategy - additionalProperties: false - properties: - type: + key: type: string - enum: - - auto - required: - - type - StaticChunkingStrategyRequestParam: + description: + type: string + configurations: + type: object + oneOf: + - $ref: '#/components/schemas/OpenAIConfiguration' + title: OpenAI + - title: Anthropic + allOf: + - $ref: '#/components/schemas/AnthropicConfiguration' + - $ref: '#/components/schemas/AzureOpenAIConfiguration' + title: Azure OpenAI + - $ref: '#/components/schemas/BedrockConfiguration' + title: AWS Bedrock + - $ref: '#/components/schemas/VertexAIConfiguration' + title: Vertex AI + - $ref: '#/components/schemas/AzureAIConfiguration' + title: Azure AI + - $ref: '#/components/schemas/WorkersAIConfiguration' + title: Workers AI + - $ref: '#/components/schemas/SageMakerConfiguration' + title: AWS Sagemaker + - $ref: '#/components/schemas/HuggingFaceConfiguration' + title: Hugginface + - $ref: '#/components/schemas/CortexConfiguration' + title: Cortex + - $ref: '#/components/schemas/CustomHostConfiguration' + title: Custom Base URL + tags: + type: object + additionalProperties: + type: string + nullable: true + description: '' + secret_mappings: + type: array + items: + $ref: '#/components/schemas/SecretMapping' + pricing_adjustments: + $ref: '#/components/schemas/PricingAdjustments' + IntegrationDetailResponse: + allOf: + - $ref: '#/components/schemas/IntegrationList' + - type: object + properties: + masked_key: + type: string + configurations: + type: object + oneOf: + - $ref: '#/components/schemas/OpenAIConfiguration' + title: OpenAI + - title: Anthropic + allOf: + - $ref: '#/components/schemas/AnthropicConfiguration' + - $ref: '#/components/schemas/AzureOpenAIConfiguration' + title: Azure OpenAI + - $ref: '#/components/schemas/BedrockConfiguration' + title: AWS Bedrock + - $ref: '#/components/schemas/VertexAIConfiguration' + title: Vertex AI + - $ref: '#/components/schemas/AzureAIConfiguration' + title: Azure AI + - $ref: '#/components/schemas/WorkersAIConfiguration' + title: Workers AI + - $ref: '#/components/schemas/SageMakerConfiguration' + title: AWS Sagemaker + - $ref: '#/components/schemas/HuggingFaceConfiguration' + title: Hugginface + - $ref: '#/components/schemas/CortexConfiguration' + title: Cortex + - $ref: '#/components/schemas/CustomHostConfiguration' + title: Custom Base URL + global_workspace_access_settings: + type: object + nullable: true + $ref: '#/components/schemas/GlobalWorkspaceAccess' + allow_all_models: + type: boolean + workspace_count: + type: integer + secret_mappings: + type: array + items: + $ref: '#/components/schemas/SecretMapping' + pricing_adjustments: + $ref: '#/components/schemas/PricingAdjustments' + PricingAdjustments: type: object - title: Static Chunking Strategy + nullable: true additionalProperties: false properties: - type: - type: string - enum: - - static - static: - $ref: '#/components/schemas/StaticChunkingStrategy' - required: - - type - - static - ChunkingStrategyRequestParam: - type: object - oneOf: - - $ref: '#/components/schemas/AutoChunkingStrategyRequestParam' - - $ref: '#/components/schemas/StaticChunkingStrategyRequestParam' - x-oaiExpandable: true - CreateVectorStoreFileRequest: + multiplier: + $ref: '#/components/schemas/PricingMultiplier' + PricingMultiplier: type: object additionalProperties: false properties: - file_id: - type: string - chunking_strategy: - $ref: '#/components/schemas/ChunkingStrategyRequestParam' + default: + type: number + nullable: true + minimum: 0 + request_token: + type: number + nullable: true + minimum: 0 + response_token: + type: number + nullable: true + minimum: 0 + cache_read_input_token: + type: number + nullable: true + minimum: 0 + cache_write_input_token: + type: number + nullable: true + minimum: 0 + cache_read_audio_input_token: + type: number + nullable: true + minimum: 0 + request_audio_token: + type: number + nullable: true + minimum: 0 + response_audio_token: + type: number + nullable: true + minimum: 0 + reasoning_token: + type: number + nullable: true + minimum: 0 + prediction_accepted_token: + type: number + nullable: true + minimum: 0 + prediction_rejected_token: + type: number + nullable: true + minimum: 0 + request_image_token: + type: number + nullable: true + minimum: 0 + response_image_token: + type: number + nullable: true + minimum: 0 + request_text_token: + type: number + nullable: true + minimum: 0 + response_text_token: + type: number + nullable: true + minimum: 0 + cache_read_image_input_token: + type: number + nullable: true + minimum: 0 + cache_read_text_input_token: + type: number + nullable: true + minimum: 0 + cache_write_text_input_token: + type: number + nullable: true + minimum: 0 + cache_write_image_input_token: + type: number + nullable: true + minimum: 0 + image: + type: object + nullable: true + additionalProperties: false + properties: + default: + type: number + nullable: true + minimum: 0 + additional_units: + type: object + nullable: true + additionalProperties: + type: number + nullable: true + minimum: 0 + GlobalWorkspaceAccess: + type: object required: - - file_id - ListVectorStoreFilesResponse: + - enabled properties: - object: - type: string - data: + enabled: + type: boolean + usage_limits: type: array + nullable: true + maxItems: 1 items: - $ref: '#/components/schemas/VectorStoreFileObject' - first_id: - type: string - last_id: - type: string - has_more: - type: boolean - required: - - object - - data - - first_id - - last_id - - has_more - DeleteVectorStoreFileResponse: + $ref: '#/components/schemas/UsageLimits' + rate_limits: + type: array + nullable: true + maxItems: 1 + items: + $ref: '#/components/schemas/RateLimits' + OpenAIConfiguration: type: object properties: - id: - type: string - deleted: - type: boolean - object: + provider_auth_type: type: string enum: - - vector_store.file.deleted - required: - - id - - object - - deleted - VectorStoreFileAttributes: - type: object - maxProperties: 16 - additionalProperties: - oneOf: - - type: string - maxLength: 512 - - type: number - - type: boolean - x-oaiTypeLabel: map - nullable: true - VectorStoreFileBatchObject: - type: object - title: Vector store file batch - properties: - id: + - apiKey + - oauthClientCredentials + - wif + default: apiKey + description: '' + openai_organization: type: string - object: + openai_project: type: string - enum: - - vector_store.files_batch - created_at: - type: integer - vector_store_id: + oauth_token_endpoint: type: string - status: + description: '' + oauth_client_id: + type: string + description: '' + oauth_client_secret: + type: string + description: '' + oauth_scope: + type: string + description: '' + wif_identity_source: type: string enum: - - in_progress - - completed - - cancelled - - failed - file_counts: - type: object - properties: - in_progress: - type: integer - completed: - type: integer - failed: - type: integer - cancelled: - type: integer - total: - type: integer - required: - - in_progress - - completed - - cancelled - - failed - - total - required: - - id - - object - - created_at - - vector_store_id - - status - - file_counts - CreateVectorStoreFileBatchRequest: + - configuredIdp + default: configuredIdp + description: '' + oauth_audience: + type: string + description: '' + openai_identity_provider_id: + type: string + description: '' + openai_service_account_id: + type: string + description: '' + is_key_required: + type: boolean + default: true + description: '' + AzureOpenAIConfiguration: type: object - additionalProperties: false + required: + - azure_resource_name + - azure_deployment_config + - azure_auth_mode properties: - file_ids: + azure_auth_mode: + type: string + enum: + - default + - entra + - managed + azure_resource_name: + type: string + azure_deployment_config: type: array minItems: 1 - maxItems: 500 items: - type: string - chunking_strategy: - $ref: '#/components/schemas/ChunkingStrategyRequestParam' - required: - - file_ids - Tool: - oneOf: - - $ref: '#/components/schemas/FileSearchTool' - - $ref: '#/components/schemas/FunctionTool' - - $ref: '#/components/schemas/ComputerTool' - - $ref: '#/components/schemas/WebSearchTool' - x-oaiExpandable: true - ToolChoiceFunction: - type: object - title: Function tool - properties: - type: + $ref: '#/components/schemas/AzureDeploymentConfig' + azure_entra_tenant_id: type: string - enum: - - function - x-stainless-const: true - name: + azure_entra_client_id: type: string - required: - - type - - name - ToolChoiceOptions: - type: string - title: Tool choice mode - enum: - - none - - auto - - required - ToolChoiceTypes: + azure_entra_client_secret: + type: string + azure_managed_client_id: + type: string + AzureDeploymentConfig: type: object - title: Hosted tool + required: + - azure_api_version + - azure_deployment_name + - azure_model_slug properties: - type: + alias: type: string - enum: - - file_search - - web_search_preview - - computer_use_preview - - web_search_preview_2025_03_11 - required: - - type - FileCitation: + azure_api_version: + type: string + maxLength: 30 + azure_deployment_name: + type: string + is_default: + type: boolean + default: false + azure_model_slug: + type: string + BedrockConfiguration: type: object - title: File citation + required: + - aws_auth_type + - aws_region properties: - type: + aws_auth_type: type: string enum: - - file_citation - x-stainless-const: true - index: - type: integer - file_id: + - accessKey + - assumedRole + aws_region: type: string - required: - - type - - index - - file_id - FilePath: + aws_access_key_id: + type: string + aws_secret_access_key: + type: string + aws_role_arn: + type: string + aws_external_id: + type: string + nullable: true + SageMakerConfiguration: + allOf: + - $ref: '#/components/schemas/BedrockConfiguration' + - type: object + properties: + amzn_sagemaker_custom_attributes: + type: string + amzn_sagemaker_target_model: + type: string + amzn_sagemaker_target_variant: + type: string + amzn_sagemaker_target_container_hostname: + type: string + amzn_sagemaker_inference_id: + type: string + amzn_sagemaker_enable_explanations: + type: string + amzn_sagemaker_inference_component: + type: string + amzn_sagemaker_session_id: + type: string + amzn_sagemaker_model_name: + type: string + VertexAIConfiguration: type: object - title: File path + required: + - vertex_auth_type + - vertex_region properties: - type: + vertex_auth_type: type: string enum: - - file_path - x-stainless-const: true - file_id: + - basic + - serviceAccount + vertex_region: type: string - index: - type: integer - required: - - type - - file_id - - index - Batch: + vertex_project_id: + type: string + vertex_service_account_json: + type: object + AzureAIConfiguration: type: object + required: + - azure_foundry_url + - azure_auth_mode properties: - id: - type: string - object: + azure_auth_mode: type: string enum: - - batch - endpoint: - type: string - errors: - type: object - properties: - object: - type: string - data: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - param: - type: string - nullable: true - line: - type: integer - nullable: true - input_file_id: - type: string - completion_window: + - default + - entra + - managed + azure_foundry_url: type: string - status: + azure_api_version: type: string - enum: - - validating - - failed - - in_progress - - finalizing - - completed - - expired - - cancelling - - cancelled - output_file_id: + maxLength: 30 + azure_deployment_name: type: string - error_file_id: + azure_entra_tenant_id: type: string - created_at: - type: integer - in_progress_at: - type: integer - expires_at: - type: integer - finalizing_at: - type: integer - completed_at: - type: integer - failed_at: - type: integer - expired_at: - type: integer - cancelling_at: - type: integer - cancelled_at: - type: integer - request_counts: - type: object - properties: - total: - type: integer - completed: - type: integer - failed: - type: integer - required: - - total - - completed - - failed - metadata: - type: object - x-oaiTypeLabel: map - nullable: true - required: - - id - - object - - endpoint - - input_file_id - - completion_window - - status - - created_at - ListBatchesResponse: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/Batch' - first_id: + azure_entra_client_id: type: string - last_id: + azure_entra_client_secret: type: string - has_more: - type: boolean - object: + azure_managed_client_id: type: string - enum: - - list - required: - - object - - data - - has_more - FeedbackRequest: + WorkersAIConfiguration: type: object required: - - trace_id - - value + - workers_ai_account_id properties: - trace_id: + workers_ai_account_id: type: string - value: - type: integer - minimum: -10 - maximum: 10 - weight: - type: number - format: float - minimum: 0 - maximum: 1 - default: 1.0 - metadata: - type: object - additionalProperties: true - FeedbackResponse: + HuggingFaceConfiguration: type: object properties: - status: - type: string - message: + huggingface_base_url: type: string - feedback_ids: - type: array - items: - type: string - FeedbackUpdateRequest: + CortexConfiguration: type: object required: - - value + - snowflake_account properties: - value: - type: integer - minimum: -10 - maximum: 10 - weight: - type: number - format: float - minimum: 0 - maximum: 1 - default: 1.0 - metadata: - type: object - additionalProperties: true - RateLimits: + snowflake_account: + type: string + CustomHostConfiguration: type: object properties: - type: - type: string - enum: - - requests - - tokens - unit: + custom_host: type: string - enum: - - rpd - - rph - - rpm - value: - type: integer - UsageLimits: + custom_headers: + type: object + additionalProperties: + type: string + SecretMapping: type: object + required: + - target_field + - secret_reference_id properties: - credit_limit: - type: integer - minimum: 1 - type: + target_field: type: string - enum: - - cost - - tokens - alert_threshold: - type: integer - minimum: 1 - periodic_reset: + secret_reference_id: + type: string + secret_key: type: string - enum: - - monthly - - weekly - nullable: true - periodic_reset_days: - type: integer - minimum: 1 - maximum: 365 nullable: true - next_usage_reset_at: + value_format: type: string - format: date-time nullable: true - CreateIntegrationRequest: + enum: + - json + - string + CreateSecretReferenceRequest: type: object required: - name - - ai_provider_id + - manager_type + - auth_config + - secret_path properties: - name: - type: string - slug: + organisation_id: type: string - pattern: ^[a-zA-Z0-9_-]+$ - ai_provider_id: + format: uuid + name: type: string - key: + minLength: 1 + maxLength: 255 + slug: type: string + pattern: ^[a-zA-Z0-9_-]+$ + maxLength: 255 description: type: string - workspace_id: + maxLength: 1024 + nullable: true + manager_type: type: string - configurations: - type: object + enum: + - aws_sm + - azure_kv + - hashicorp_vault + auth_config: oneOf: - - $ref: '#/components/schemas/OpenAIConfiguration' - title: OpenAI - - $ref: '#/components/schemas/AzureOpenAIConfiguration' - title: Azure OpenAI - - $ref: '#/components/schemas/BedrockConfiguration' - title: AWS Bedrock - - $ref: '#/components/schemas/VertexAIConfiguration' - title: Vertex AI - - $ref: '#/components/schemas/AzureAIConfiguration' - title: Azure AI - - $ref: '#/components/schemas/WorkersAIConfiguration' - title: Workers AI - - $ref: '#/components/schemas/SageMakerConfiguration' - title: AWS Sagemaker - - $ref: '#/components/schemas/HuggingFaceConfiguration' - title: Hugginface - - $ref: '#/components/schemas/CortexConfiguration' - title: Cortex - - $ref: '#/components/schemas/CustomHostConfiguration' - title: Custom Base URL - create_default_provider: - type: boolean - default: true - default_provider_slug: + - $ref: '#/components/schemas/AwsAccessKeyAuthConfig' + - $ref: '#/components/schemas/AwsAssumedRoleAuthConfig' + - $ref: '#/components/schemas/AwsServiceRoleAuthConfig' + - $ref: '#/components/schemas/AzureEntraAuthConfig' + - $ref: '#/components/schemas/AzureManagedAuthConfig' + - $ref: '#/components/schemas/AzureDefaultAuthConfig' + - $ref: '#/components/schemas/HashicorpTokenAuthConfig' + - $ref: '#/components/schemas/HashicorpAppRoleAuthConfig' + - $ref: '#/components/schemas/HashicorpKubernetesAuthConfig' + discriminator: + propertyName: aws_auth_type + secret_path: + type: string + maxLength: 1024 + secret_key: type: string - pattern: ^[a-zA-Z0-9_-]+$ maxLength: 255 - secret_mappings: + nullable: true + allow_all_workspaces: + type: boolean + default: true + allowed_workspaces: type: array items: - $ref: '#/components/schemas/SecretMapping' - pricing_adjustments: - $ref: '#/components/schemas/PricingAdjustments' - UpdateIntegrationRequest: + type: string + minItems: 1 + tags: + type: object + additionalProperties: + type: string + nullable: true + UpdateSecretReferenceRequest: type: object properties: name: type: string - key: - type: string + minLength: 1 + maxLength: 255 description: type: string - configurations: + maxLength: 1024 + nullable: true + auth_config: type: object - oneOf: - - $ref: '#/components/schemas/OpenAIConfiguration' - title: OpenAI - - $ref: '#/components/schemas/AzureOpenAIConfiguration' - title: Azure OpenAI - - $ref: '#/components/schemas/BedrockConfiguration' - title: AWS Bedrock - - $ref: '#/components/schemas/VertexAIConfiguration' - title: Vertex AI - - $ref: '#/components/schemas/AzureAIConfiguration' - title: Azure AI - - $ref: '#/components/schemas/WorkersAIConfiguration' - title: Workers AI - - $ref: '#/components/schemas/SageMakerConfiguration' - title: AWS Sagemaker - - $ref: '#/components/schemas/HuggingFaceConfiguration' - title: Hugginface - - $ref: '#/components/schemas/CortexConfiguration' - title: Cortex - - $ref: '#/components/schemas/CustomHostConfiguration' - title: Custom Base URL - secret_mappings: + secret_path: + type: string + maxLength: 1024 + secret_key: + type: string + maxLength: 255 + nullable: true + allow_all_workspaces: + type: boolean + allowed_workspaces: type: array items: - $ref: '#/components/schemas/SecretMapping' - pricing_adjustments: - $ref: '#/components/schemas/PricingAdjustments' - IntegrationDetailResponse: - allOf: - - $ref: '#/components/schemas/IntegrationList' - - type: object - properties: - masked_key: type: string - configurations: - type: object - oneOf: - - $ref: '#/components/schemas/OpenAIConfiguration' - title: OpenAI - - $ref: '#/components/schemas/AzureOpenAIConfiguration' - title: Azure OpenAI - - $ref: '#/components/schemas/BedrockConfiguration' - title: AWS Bedrock - - $ref: '#/components/schemas/VertexAIConfiguration' - title: Vertex AI - - $ref: '#/components/schemas/AzureAIConfiguration' - title: Azure AI - - $ref: '#/components/schemas/WorkersAIConfiguration' - title: Workers AI - - $ref: '#/components/schemas/SageMakerConfiguration' - title: AWS Sagemaker - - $ref: '#/components/schemas/HuggingFaceConfiguration' - title: Hugginface - - $ref: '#/components/schemas/CortexConfiguration' - title: Cortex - - $ref: '#/components/schemas/CustomHostConfiguration' - title: Custom Base URL - global_workspace_access_settings: - type: object - nullable: true - $ref: '#/components/schemas/GlobalWorkspaceAccess' - allow_all_models: - type: boolean - workspace_count: - type: integer - secret_mappings: - type: array - items: - $ref: '#/components/schemas/SecretMapping' - pricing_adjustments: - $ref: '#/components/schemas/PricingAdjustments' - PricingAdjustments: - type: object - nullable: true - additionalProperties: false - properties: - multiplier: - $ref: '#/components/schemas/PricingMultiplier' - PricingMultiplier: + minItems: 1 + tags: + type: object + additionalProperties: + type: string + nullable: true + SecretReferenceListItem: type: object - additionalProperties: false properties: - default: - type: number - nullable: true - minimum: 0 - request_token: - type: number - nullable: true - minimum: 0 - response_token: - type: number - nullable: true - minimum: 0 - cache_read_input_token: - type: number - nullable: true - minimum: 0 - cache_write_input_token: - type: number - nullable: true - minimum: 0 - cache_read_audio_input_token: - type: number - nullable: true - minimum: 0 - request_audio_token: - type: number - nullable: true - minimum: 0 - response_audio_token: - type: number - nullable: true - minimum: 0 - reasoning_token: - type: number - nullable: true - minimum: 0 - prediction_accepted_token: - type: number - nullable: true - minimum: 0 - prediction_rejected_token: - type: number - nullable: true - minimum: 0 - request_image_token: - type: number - nullable: true - minimum: 0 - response_image_token: - type: number - nullable: true - minimum: 0 - request_text_token: - type: number - nullable: true - minimum: 0 - response_text_token: - type: number - nullable: true - minimum: 0 - cache_read_image_input_token: - type: number - nullable: true - minimum: 0 - cache_read_text_input_token: - type: number - nullable: true - minimum: 0 - cache_write_text_input_token: - type: number + id: + type: string + format: uuid + name: + type: string + slug: + type: string + manager_type: + type: string + enum: + - aws_sm + - azure_kv + - hashicorp_vault + status: + type: string + enum: + - ACTIVE + created_at: + type: string + format: date-time + last_updated_at: + type: string + format: date-time + object: + type: string + enum: + - secret-reference + SecretReferenceDetailResponse: + type: object + properties: + id: + type: string + format: uuid + organisation_id: + type: string + format: uuid + name: + type: string + slug: + type: string + description: + type: string nullable: true - minimum: 0 - cache_write_image_input_token: - type: number + manager_type: + type: string + enum: + - aws_sm + - azure_kv + - hashicorp_vault + secret_path: + type: string + secret_key: + type: string nullable: true - minimum: 0 - image: + allow_all_workspaces: + type: boolean + tags: type: object + additionalProperties: + type: string nullable: true - additionalProperties: false - properties: - default: - type: number - nullable: true - minimum: 0 - additional_units: + status: + type: string + enum: + - ACTIVE + created_by: + type: string + created_at: + type: string + format: date-time + last_updated_at: + type: string + format: date-time + auth_config: type: object - nullable: true - additionalProperties: - type: number - nullable: true - minimum: 0 - GlobalWorkspaceAccess: + object: + type: string + enum: + - secret-reference + AwsAccessKeyAuthConfig: type: object required: - - enabled + - aws_auth_type + - aws_access_key_id + - aws_secret_access_key + - aws_region properties: - enabled: - type: boolean - usage_limits: - type: array - nullable: true - maxItems: 1 - items: - $ref: '#/components/schemas/UsageLimits' - rate_limits: - type: array + aws_auth_type: + type: string + enum: + - accessKey + aws_access_key_id: + type: string + aws_secret_access_key: + type: string + aws_region: + type: string + AwsAssumedRoleAuthConfig: + type: object + required: + - aws_auth_type + - aws_role_arn + - aws_region + properties: + aws_auth_type: + type: string + enum: + - assumedRole + aws_role_arn: + type: string + aws_external_id: + type: string nullable: true - maxItems: 1 - items: - $ref: '#/components/schemas/RateLimits' - OpenAIConfiguration: + aws_region: + type: string + AwsServiceRoleAuthConfig: type: object + required: + - aws_auth_type properties: - openai_organization: + aws_auth_type: type: string - openai_project: + enum: + - serviceRole + aws_region: type: string - AzureOpenAIConfiguration: + AzureEntraAuthConfig: type: object required: - - azure_resource_name - - azure_deployment_config - azure_auth_mode + - azure_entra_tenant_id + - azure_entra_client_id + - azure_entra_client_secret + - azure_vault_url properties: azure_auth_mode: type: string enum: - - default - entra - - managed - azure_resource_name: - type: string - azure_deployment_config: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/AzureDeploymentConfig' azure_entra_tenant_id: type: string azure_entra_client_id: type: string azure_entra_client_secret: type: string - azure_managed_client_id: + azure_vault_url: type: string - AzureDeploymentConfig: + format: uri + AzureManagedAuthConfig: type: object required: - - azure_api_version - - azure_deployment_name - - azure_model_slug + - azure_auth_mode + - azure_vault_url properties: - alias: + azure_auth_mode: type: string - azure_api_version: + enum: + - managed + azure_managed_client_id: type: string - maxLength: 30 - azure_deployment_name: + azure_vault_url: type: string - is_default: - type: boolean - default: false - azure_model_slug: + format: uri + AzureDefaultAuthConfig: + type: object + required: + - azure_auth_mode + - azure_vault_url + properties: + azure_auth_mode: type: string - BedrockConfiguration: + enum: + - default + azure_vault_url: + type: string + format: uri + HashicorpTokenAuthConfig: type: object required: - - aws_auth_type - - aws_region + - vault_auth_type + - vault_addr + - vault_token properties: - aws_auth_type: + vault_auth_type: type: string enum: - - accessKey - - assumedRole - aws_region: + - token + vault_addr: type: string - aws_access_key_id: + format: uri + vault_token: type: string - aws_secret_access_key: + vault_namespace: type: string - aws_role_arn: + HashicorpAppRoleAuthConfig: + type: object + required: + - vault_auth_type + - vault_addr + - vault_role_id + - vault_secret_id + properties: + vault_auth_type: type: string - aws_external_id: + enum: + - approle + vault_addr: type: string - nullable: true - SageMakerConfiguration: - allOf: - - $ref: '#/components/schemas/BedrockConfiguration' - - type: object - properties: - amzn_sagemaker_custom_attributes: - type: string - amzn_sagemaker_target_model: - type: string - amzn_sagemaker_target_variant: - type: string - amzn_sagemaker_target_container_hostname: - type: string - amzn_sagemaker_inference_id: - type: string - amzn_sagemaker_enable_explanations: - type: string - amzn_sagemaker_inference_component: - type: string - amzn_sagemaker_session_id: - type: string - amzn_sagemaker_model_name: - type: string - VertexAIConfiguration: + format: uri + vault_role_id: + type: string + vault_secret_id: + type: string + vault_namespace: + type: string + HashicorpKubernetesAuthConfig: type: object required: - - vertex_auth_type - - vertex_region + - vault_auth_type + - vault_addr + - vault_role properties: - vertex_auth_type: + vault_auth_type: type: string enum: - - basic - - serviceAccount - vertex_region: + - kubernetes + vault_addr: type: string - vertex_project_id: + format: uri + vault_role: type: string - vertex_service_account_json: - type: object - AzureAIConfiguration: + vault_namespace: + type: string + IntegrationList: type: object - required: - - azure_foundry_url - - azure_auth_mode properties: - azure_auth_mode: + id: type: string - enum: - - default - - entra - - managed - azure_foundry_url: + format: UUID + organisation_id: type: string - azure_api_version: + format: UUID + ai_provider_id: type: string - maxLength: 30 - azure_deployment_name: + name: type: string - azure_entra_tenant_id: + status: type: string - azure_entra_client_id: + enum: + - active + - archived + created_at: type: string - azure_entra_client_secret: + format: date-time + last_updated_at: type: string - azure_managed_client_id: + format: date-time + nullable: true + slug: type: string - WorkersAIConfiguration: + description: + type: string + object: + type: string + enum: + - integration + IntegrationModelsResponse: type: object - required: - - workers_ai_account_id properties: - workers_ai_account_id: - type: string - HuggingFaceConfiguration: + total: + type: integer + models: + type: array + items: + $ref: '#/components/schemas/IntegrationModel' + IntegrationModel: type: object properties: - huggingface_base_url: + slug: type: string - CortexConfiguration: + name: + type: string + enabled: + type: boolean + is_custom: + type: boolean + nullable: true + is_finetune: + type: boolean + nullable: true + base_model_slug: + type: string + nullable: true + pricing_config: + $ref: '#/components/schemas/PricingConfig' + PricingConfig: type: object - required: - - snowflake_account properties: - snowflake_account: + type: type: string - CustomHostConfiguration: + enum: + - static + pay_as_you_go: + $ref: '#/components/schemas/PayAsYouGoPricing' + PayAsYouGoPricing: + type: object + properties: + request_token: + $ref: '#/components/schemas/TokenPricing' + response_token: + $ref: '#/components/schemas/TokenPricing' + ModelConfigurations: type: object properties: custom_host: type: string custom_headers: type: object - additionalProperties: - type: string - SecretMapping: + properties: + key: + type: string + value: + type: string + TokenPricing: + type: object + properties: + price: + type: number + format: float + BulkUpdateModelsRequest: type: object required: - - target_field - - secret_reference_id + - models properties: - target_field: - type: string - secret_reference_id: - type: string - secret_key: - type: string - nullable: true - value_format: - type: string - nullable: true - enum: - - json - - string - CreateSecretReferenceRequest: + models: + type: array + items: + $ref: '#/components/schemas/ModelUpdateRequest' + allow_all_models: + type: boolean + ModelUpdateRequest: type: object required: - - name - - manager_type - - auth_config - - secret_path + - slug + - enabled properties: - organisation_id: - type: string - format: uuid - name: - type: string - minLength: 1 - maxLength: 255 slug: type: string - pattern: ^[a-zA-Z0-9_-]+$ - maxLength: 255 - description: - type: string - maxLength: 1024 + enabled: + type: boolean + is_custom: + type: boolean nullable: true - manager_type: - type: string - enum: - - aws_sm - - azure_kv - - hashicorp_vault - auth_config: - oneOf: - - $ref: '#/components/schemas/AwsAccessKeyAuthConfig' - - $ref: '#/components/schemas/AwsAssumedRoleAuthConfig' - - $ref: '#/components/schemas/AwsServiceRoleAuthConfig' - - $ref: '#/components/schemas/AzureEntraAuthConfig' - - $ref: '#/components/schemas/AzureManagedAuthConfig' - - $ref: '#/components/schemas/AzureDefaultAuthConfig' - - $ref: '#/components/schemas/HashicorpTokenAuthConfig' - - $ref: '#/components/schemas/HashicorpAppRoleAuthConfig' - - $ref: '#/components/schemas/HashicorpKubernetesAuthConfig' - discriminator: - propertyName: aws_auth_type - secret_path: - type: string - maxLength: 1024 - secret_key: + is_finetune: + type: boolean + nullable: true + base_model_slug: type: string - maxLength: 255 nullable: true - allow_all_workspaces: - type: boolean - default: true - allowed_workspaces: + configurations: + $ref: '#/components/schemas/ModelConfigurations' + pricing_config: + $ref: '#/components/schemas/PricingConfig' + IntegrationWorkspacesResponse: + type: object + properties: + total: + type: integer + workspaces: type: array items: - type: string - minItems: 1 - tags: - type: object - additionalProperties: - type: string - nullable: true - UpdateSecretReferenceRequest: + $ref: '#/components/schemas/IntegrationWorkspace' + IntegrationWorkspace: type: object properties: - name: - type: string - minLength: 1 - maxLength: 255 - description: + id: type: string - maxLength: 1024 + enabled: + type: boolean + usage_limits: + type: array nullable: true - auth_config: - type: object - secret_path: + items: + $ref: '#/components/schemas/UsageLimits' + rate_limits: + type: array + nullable: true + items: + $ref: '#/components/schemas/RateLimits' + BulkUpdateWorkspacesRequest: + type: object + properties: + workspaces: + type: array + items: + $ref: '#/components/schemas/WorkspaceUpdateRequest' + global_workspace_access: + $ref: '#/components/schemas/GlobalWorkspaceAccess' + override_existing_workspace_access: + type: boolean + create_default_provider: + type: boolean + default: true + default_provider_slug: type: string - maxLength: 1024 - secret_key: + WorkspaceUpdateRequest: + type: object + required: + - id + - enabled + properties: + id: type: string - maxLength: 255 - nullable: true - allow_all_workspaces: + enabled: type: boolean - allowed_workspaces: + usage_limits: type: array + nullable: true + maxItems: 1 items: - type: string - minItems: 1 - tags: - type: object - additionalProperties: - type: string + $ref: '#/components/schemas/UsageLimits' + rate_limits: + type: array nullable: true - SecretReferenceListItem: + maxItems: 1 + items: + $ref: '#/components/schemas/RateLimits' + reset_usage: + type: boolean + create_default_provider: + type: boolean + default_provider_slug: + type: string + Providers: type: object properties: - id: - type: string - format: uuid name: type: string - slug: + integration_id: type: string - manager_type: + note: type: string - enum: - - aws_sm - - azure_kv - - hashicorp_vault + nullable: true status: type: string enum: - - ACTIVE + - active + - exhausted + - expired + usage_limits: + $ref: '#/components/schemas/UsageLimits' + reset_usage: + type: number + nullable: true created_at: type: string format: date-time - last_updated_at: + slug: + type: string + rate_limits: + type: array + items: + $ref: '#/components/schemas/RateLimits' + nullable: true + expires_at: type: string format: date-time object: type: string enum: - - secret-reference - SecretReferenceDetailResponse: + - provider + CustomLog: type: object properties: - id: + request: + type: object + properties: + url: + type: string + method: + type: string + headers: + type: object + additionalProperties: + type: string + body: + type: object + required: + - url + - body + response: + type: object + properties: + status: + type: integer + headers: + type: object + additionalProperties: + type: string + body: + type: object + response_time: + type: integer + required: + - body + metadata: + type: object + properties: + trace_id: + type: string + span_id: + type: string + span_name: + type: string + additionalProperties: + type: string + required: + - request + - response + LogObject: + type: object + required: + - _id + - request + - response + - organisation_id + - created_at + properties: + _id: type: string format: uuid + nullable: true + request: + $ref: '#/components/schemas/LogRequest' + response: + $ref: '#/components/schemas/LogResponse' organisation_id: - type: string - format: uuid - name: - type: string - slug: - type: string - description: type: string nullable: true - manager_type: + created_at: type: string - enum: - - aws_sm - - azure_kv - - hashicorp_vault - secret_path: + format: date-time + nullable: true + metrics: + $ref: '#/components/schemas/AnalyticsMetrics' + finalUntransformedRequest: + $ref: '#/components/schemas/RequestResponseObject' + originalResponse: + $ref: '#/components/schemas/RequestResponseObject' + transformedRequest: + $ref: '#/components/schemas/RequestResponseObject' + LogRequest: + type: object + required: + - url + - method + - portkeyHeaders + properties: + url: type: string - secret_key: + format: uri + method: type: string - nullable: true - allow_all_workspaces: - type: boolean - tags: + enum: + - GET + - POST + - PUT + - DELETE + - PATCH + - OPTIONS + - HEAD + headers: type: object additionalProperties: type: string - nullable: true - status: - type: string - enum: - - ACTIVE - created_by: - type: string - created_at: - type: string - format: date-time - last_updated_at: - type: string - format: date-time - auth_config: + body: type: object - object: - type: string - enum: - - secret-reference - AwsAccessKeyAuthConfig: + additionalProperties: true + portkeyHeaders: + type: object + additionalProperties: + type: string + LogResponse: type: object required: - - aws_auth_type - - aws_access_key_id - - aws_secret_access_key - - aws_region + - status + - responseTime + - lastUsedOptionJsonPath properties: - aws_auth_type: - type: string - enum: - - accessKey - aws_access_key_id: + status: + type: integer + format: int32 + headers: + type: object + additionalProperties: + type: string + body: + type: object + additionalProperties: true + responseTime: + type: integer + format: int64 + lastUsedOptionJsonPath: type: string - aws_secret_access_key: + RequestResponseObject: + type: object + properties: + body: + type: object + additionalProperties: true + headers: + type: object + additionalProperties: + type: string + url: type: string - aws_region: + format: uri + method: type: string - AwsAssumedRoleAuthConfig: - type: object - required: - - aws_auth_type - - aws_role_arn - - aws_region + AnalyticsMetrics: + type: object properties: - aws_auth_type: + id: type: string - enum: - - assumedRole - aws_role_arn: + format: uuid + organisation_id: type: string - aws_external_id: + organisation_name: type: string - nullable: true - aws_region: + prompt_id: type: string - AwsServiceRoleAuthConfig: - type: object - required: - - aws_auth_type - properties: - aws_auth_type: + prompt_version_id: type: string - enum: - - serviceRole - aws_region: + config_id: type: string - AzureEntraAuthConfig: - type: object - required: - - azure_auth_mode - - azure_entra_tenant_id - - azure_entra_client_id - - azure_entra_client_secret - - azure_vault_url - properties: - azure_auth_mode: + created_at: type: string - enum: - - entra - azure_entra_tenant_id: + format: date-time + is_success: + type: boolean + ai_org: type: string - azure_entra_client_id: + ai_model: type: string - azure_entra_client_secret: + req_units: + type: number + format: float + res_units: + type: number + format: float + total_units: + type: number + format: float + cost: + type: number + format: float + cost_currency: type: string - azure_vault_url: + default: USD + request_url: type: string format: uri - AzureManagedAuthConfig: - type: object - required: - - azure_auth_mode - - azure_vault_url - properties: - azure_auth_mode: + request_method: type: string - enum: - - managed - azure_managed_client_id: + response_status_code: + type: integer + format: int32 + response_time: + type: integer + format: int64 + is_proxy_call: + type: boolean + cache_status: type: string - azure_vault_url: + nullable: true + cache_type: type: string - format: uri - AzureDefaultAuthConfig: - type: object - required: - - azure_auth_mode - - azure_vault_url - properties: - azure_auth_mode: + nullable: true + stream_mode: + type: integer + nullable: true + retry_success_count: + type: integer + trace_id: type: string - enum: - - default - azure_vault_url: + span_id: type: string - format: uri - HashicorpTokenAuthConfig: - type: object - required: - - vault_auth_type - - vault_addr - - vault_token - properties: - vault_auth_type: + span_name: type: string - enum: - - token - vault_addr: + parent_span_id: type: string - format: uri - vault_token: + mode: type: string - vault_namespace: + virtual_key: type: string - HashicorpAppRoleAuthConfig: - type: object - required: - - vault_auth_type - - vault_addr - - vault_role_id - - vault_secret_id - properties: - vault_auth_type: + source: type: string - enum: - - approle - vault_addr: + runtime: type: string - format: uri - vault_role_id: + runtime_version: type: string - vault_secret_id: + sdk_version: type: string - vault_namespace: + config: type: string - HashicorpKubernetesAuthConfig: - type: object - required: - - vault_auth_type - - vault_addr - - vault_role - properties: - vault_auth_type: + internal_trace_id: type: string - enum: - - kubernetes - vault_addr: + last_used_option_index: + type: integer + config_version_id: type: string - format: uri - vault_role: + prompt_slug: type: string - vault_namespace: + workspace_slug: type: string - IntegrationList: + nullable: true + log_store_file_path_format: + type: string + metadata.key: + type: array + items: + type: string + nullable: true + metadata.value: + type: array + items: + type: string + nullable: true + api_key_id: + type: string + request_parsing_time: + type: integer + format: int64 + pre_processing_time: + type: integer + format: int64 + cache_processing_time: + type: integer + format: int64 + response_parsing_time: + type: integer + format: int64 + gateway_processing_time: + type: integer + format: int64 + upstream_response_time: + type: integer + format: int64 + ApiKeyObject: type: object properties: id: type: string - format: UUID + format: uuid + key: + type: string + name: + type: string + description: + type: string + type: + type: string + enum: + - organisation-service + - workspace-service + - workspace-user organisation_id: type: string - format: UUID - ai_provider_id: + format: uuid + workspace_id: type: string - name: + user_id: type: string + format: uuid status: type: string enum: - active - - archived + - exhausted created_at: type: string format: date-time last_updated_at: type: string format: date-time - nullable: true - slug: - type: string - description: - type: string + creation_mode: + type: string + enum: + - ui + - api + - auto + rate_limits: + type: array + items: + type: object + properties: + type: + type: string + unit: + type: string + value: + type: integer + usage_limits: + $ref: '#/components/schemas/UsageLimits' + reset_usage: + type: number + scopes: + type: array + items: + type: string + defaults: + type: object + properties: + metadata: + type: object + additionalProperties: true + config_id: + type: string + alert_emails: + type: array + items: + type: string + format: email + expires_at: + type: string + format: date-time object: type: string enum: - - integration - IntegrationModelsResponse: + - api-key + ApiKeyObjectList: type: object properties: total: type: integer - models: + object: + type: string + enum: + - list + data: type: array items: - $ref: '#/components/schemas/IntegrationModel' - IntegrationModel: + $ref: '#/components/schemas/ApiKeyObject' + CreateApiKeyObject: type: object + required: + - name + - scopes properties: - slug: - type: string name: type: string - enabled: - type: boolean - is_custom: - type: boolean - nullable: true - is_finetune: - type: boolean - nullable: true - base_model_slug: + description: type: string - nullable: true - pricing_config: - $ref: '#/components/schemas/PricingConfig' - PricingConfig: - type: object - properties: - type: + organisation_id: type: string - enum: - - static - pay_as_you_go: - $ref: '#/components/schemas/PayAsYouGoPricing' - PayAsYouGoPricing: - type: object - properties: - request_token: - $ref: '#/components/schemas/TokenPricing' - response_token: - $ref: '#/components/schemas/TokenPricing' - ModelConfigurations: - type: object - properties: - custom_host: + format: uuid + workspace_id: type: string - custom_headers: + user_id: + type: string + format: uuid + rate_limits: + type: array + nullable: true + items: + type: object + required: + - type + - unit + - value + properties: + type: + type: string + enum: + - requests + - tokens + unit: + type: string + enum: + - rpd + - rph + - rpm + - rps + - rpw + value: + type: integer + minimum: 0 + usage_limits: + $ref: '#/components/schemas/UsageLimits' + scopes: + type: array + items: + type: string + defaults: type: object properties: - key: - type: string - value: + metadata: + type: object + additionalProperties: true + config_id: type: string - TokenPricing: - type: object - properties: - price: - type: number - format: float - BulkUpdateModelsRequest: - type: object - required: - - models - properties: - models: + allow_config_override: + type: boolean + default: true + alert_emails: type: array items: - $ref: '#/components/schemas/ModelUpdateRequest' - allow_all_models: - type: boolean - ModelUpdateRequest: - type: object - required: - - slug - - enabled - properties: - slug: + type: string + format: email + expires_at: type: string - enabled: - type: boolean - is_custom: - type: boolean - nullable: true - is_finetune: - type: boolean + format: date-time nullable: true - base_model_slug: - type: string + rotation_policy: + type: object nullable: true - configurations: - $ref: '#/components/schemas/ModelConfigurations' - pricing_config: - $ref: '#/components/schemas/PricingConfig' - IntegrationWorkspacesResponse: + properties: + rotation_period: + type: string + enum: + - weekly + - monthly + nullable: true + next_rotation_at: + type: string + format: date-time + nullable: true + key_transition_period_ms: + type: integer + minimum: 1800000 + UpdateApiKeyObject: type: object properties: - total: - type: integer - workspaces: + name: + type: string + description: + type: string + rate_limits: type: array + nullable: true items: - $ref: '#/components/schemas/IntegrationWorkspace' - IntegrationWorkspace: - type: object - properties: - id: - type: string - enabled: - type: boolean + type: object + required: + - type + - unit + - value + properties: + type: + type: string + enum: + - requests + - tokens + unit: + type: string + enum: + - rpd + - rph + - rpm + - rps + - rpw + value: + type: integer + minimum: 0 usage_limits: + $ref: '#/components/schemas/UsageLimits' + reset_usage: + type: boolean + scopes: type: array - nullable: true items: - $ref: '#/components/schemas/UsageLimits' - rate_limits: + type: string + defaults: + type: object + properties: + metadata: + type: object + additionalProperties: true + config_id: + type: string + allow_config_override: + type: boolean + default: true + alert_emails: type: array - nullable: true items: - $ref: '#/components/schemas/RateLimits' - BulkUpdateWorkspacesRequest: + type: string + format: email + expires_at: + type: string + format: date-time + nullable: true + rotation_policy: + type: object + nullable: true + properties: + rotation_period: + type: string + enum: + - weekly + - monthly + nullable: true + next_rotation_at: + type: string + format: date-time + nullable: true + key_transition_period_ms: + type: integer + minimum: 1800000 + RotateApiKeyRequest: type: object properties: - workspaces: - type: array - items: - $ref: '#/components/schemas/WorkspaceUpdateRequest' - global_workspace_access: - $ref: '#/components/schemas/GlobalWorkspaceAccess' - override_existing_workspace_access: - type: boolean - create_default_provider: - type: boolean - default: true - default_provider_slug: - type: string - WorkspaceUpdateRequest: + key_transition_period_ms: + type: integer + minimum: 1800000 + RotateApiKeyResponse: type: object - required: - - id - - enabled properties: id: type: string - enabled: - type: boolean - usage_limits: - type: array - nullable: true - maxItems: 1 - items: - $ref: '#/components/schemas/UsageLimits' - rate_limits: - type: array - nullable: true - maxItems: 1 - items: - $ref: '#/components/schemas/RateLimits' - reset_usage: - type: boolean - create_default_provider: - type: boolean - default_provider_slug: + format: uuid + key: type: string - Providers: + key_transition_expires_at: + type: string + format: date-time + CreateGuardrailRequest: type: object + required: + - name properties: name: type: string - integration_id: - type: string - note: - type: string - nullable: true - status: + target: type: string enum: - - active - - exhausted - - expired - usage_limits: - $ref: '#/components/schemas/UsageLimits' - reset_usage: - type: number - nullable: true - created_at: + - llm + - mcp_tools + default: llm + workspace_id: type: string - format: date-time - slug: + format: uuid + organisation_id: type: string - rate_limits: + format: uuid + checks: type: array items: - $ref: '#/components/schemas/RateLimits' - nullable: true - expires_at: - type: string - format: date-time - object: + $ref: '#/components/schemas/GuardrailCheck' + minItems: 1 + actions: + $ref: '#/components/schemas/GuardrailActions' + UpdateGuardrailRequest: + type: object + properties: + name: type: string - enum: - - provider - CustomLog: + checks: + type: array + items: + $ref: '#/components/schemas/GuardrailCheck' + minItems: 1 + actions: + $ref: '#/components/schemas/GuardrailActions' + GuardrailActions: type: object properties: - request: + deny: + type: boolean + default: false + async: + type: boolean + default: false + on_success: type: object properties: - url: - type: string - method: - type: string - headers: - type: object - additionalProperties: - type: string - body: + feedback: type: object + properties: + value: + type: number + default: 5 + weight: + type: number + default: 1 + metadata: + type: string + default: '' + required: + - value + - weight + - metadata required: - - url - - body - response: + - feedback + on_fail: type: object properties: - status: - type: integer - headers: - type: object - additionalProperties: - type: string - body: + feedback: type: object - response_time: - type: integer + properties: + value: + type: number + default: -5 + weight: + type: number + default: 1 + metadata: + type: string + default: '' + required: + - value + - weight + - metadata required: - - body - metadata: - type: object - properties: - trace_id: - type: string - span_id: - type: string - span_name: - type: string - additionalProperties: - type: string + - feedback required: - - request - - response - LogObject: + - deny + - async + - on_success + - on_fail + GuardrailCheck: type: object required: - - _id - - request - - response - - organisation_id - - created_at + - id properties: - _id: - type: string - format: uuid - nullable: true - request: - $ref: '#/components/schemas/LogRequest' - response: - $ref: '#/components/schemas/LogResponse' - organisation_id: + id: type: string - nullable: true - created_at: + enum: + - default.jwt + - default.modelWhitelist + - default.isAllLowerCase + - default.regexMatch + - default.sentenceCount + - default.wordCount + - default.characterCount + - default.jsonSchema + - default.jsonKeys + - default.contains + - default.validUrls + - default.containsCode + - default.webhook + - default.endsWith + - default.alluppercase + - default.requiredMetadataKeys + - default.allowedRequestTypes + - portkey.moderateContent + - portkey.language + - portkey.pii + - portkey.gibberish + - sydelabs.sydeguard + - aporia.validateProject + - pillar.scanPrompt + - pillar.scanResponse + - patronus.phi + - patronus.pii + - patronus.isConcise + - patronus.isHelpful + - patronus.isPolite + - patronus.noApologies + - patronus.noGenderBias + - patronus.noRacialBias + - patronus.retrievalAnswerRelevance + - patronus.toxicity + - patronus.custom + - mistral.moderateContent + - bedrock.guard + - promptfoo.guard + - promptfoo.pii + - promptfoo.harm + - acuvity.scan + - lasso.classify + - azure.contentSafety + - azure.pii + - panw-prisma-airs.intercept + parameters: + oneOf: + - $ref: '#/components/schemas/JWTParameters' + - $ref: '#/components/schemas/ModelWhitelistParameters' + - $ref: '#/components/schemas/RegexMatchParameters' + - $ref: '#/components/schemas/SentenceCountParameters' + - $ref: '#/components/schemas/WordCountParameters' + - $ref: '#/components/schemas/CharacterCountParameters' + - $ref: '#/components/schemas/JSONSchemaParameters' + - $ref: '#/components/schemas/JSONKeysParameters' + - $ref: '#/components/schemas/ContainsParameters' + - $ref: '#/components/schemas/ValidUrlsParameters' + - $ref: '#/components/schemas/ContainsCodeParameters' + - $ref: '#/components/schemas/WebhookParameters' + - $ref: '#/components/schemas/EndsWithParameters' + - $ref: '#/components/schemas/UppercaseParameters' + - $ref: '#/components/schemas/RequiredMetadataKeysParameters' + - $ref: '#/components/schemas/AllowedRequestTypesParameters' + - $ref: '#/components/schemas/SydeGuardParameters' + - $ref: '#/components/schemas/AporiaParameters' + - $ref: '#/components/schemas/PillarScanParameters' + - $ref: '#/components/schemas/PatronusParameters' + - $ref: '#/components/schemas/PatronusCustomParameters' + - $ref: '#/components/schemas/PortkeyModerationParameters' + - $ref: '#/components/schemas/PortkeyLanguageParameters' + - $ref: '#/components/schemas/PortkeyPIIParameters' + - $ref: '#/components/schemas/MistralModerationParameters' + - $ref: '#/components/schemas/BedrockGuardParameters' + - $ref: '#/components/schemas/PromptfooParameters' + - $ref: '#/components/schemas/AcuvityScanParameters' + - $ref: '#/components/schemas/AzureContentSafetyParameters' + - $ref: '#/components/schemas/AzurePIIParameters' + - $ref: '#/components/schemas/PANWPrismaParameters' + - $ref: '#/components/schemas/BasicParameters' + name: type: string - format: date-time - nullable: true - metrics: - $ref: '#/components/schemas/AnalyticsMetrics' - finalUntransformedRequest: - $ref: '#/components/schemas/RequestResponseObject' - originalResponse: - $ref: '#/components/schemas/RequestResponseObject' - transformedRequest: - $ref: '#/components/schemas/RequestResponseObject' - LogRequest: + is_enabled: + type: boolean + default: true + CreateGuardrailResponse: type: object required: - - url - - method - - portkeyHeaders + - id + - slug + - version_id properties: - url: + id: type: string - format: uri - method: + slug: type: string - enum: - - GET - - POST - - PUT - - DELETE - - PATCH - - OPTIONS - - HEAD - headers: - type: object - additionalProperties: - type: string - body: - type: object - additionalProperties: true - portkeyHeaders: - type: object - additionalProperties: - type: string - LogResponse: + version_id: + type: string + UpdateGuardrailResponse: type: object required: - - status - - responseTime - - lastUsedOptionJsonPath + - id + - slug properties: - status: - type: integer - format: int32 - headers: - type: object - additionalProperties: - type: string - body: - type: object - additionalProperties: true - responseTime: - type: integer - format: int64 - lastUsedOptionJsonPath: + id: type: string - RequestResponseObject: - type: object - properties: - body: - type: object - additionalProperties: true - headers: - type: object - additionalProperties: - type: string - url: + slug: type: string - format: uri - method: + version_id: type: string - AnalyticsMetrics: + ListGuardrailsResponse: type: object + required: + - data + - total properties: - id: - type: string - format: uuid - organisation_id: - type: string - organisation_name: - type: string - prompt_id: - type: string - prompt_version_id: - type: string - config_id: - type: string - created_at: - type: string - format: date-time - is_success: - type: boolean - ai_org: - type: string - ai_model: - type: string - req_units: - type: number - format: float - res_units: - type: number - format: float - total_units: - type: number - format: float - cost: - type: number - format: float - cost_currency: - type: string - default: USD - request_url: - type: string - format: uri - request_method: - type: string - response_status_code: - type: integer - format: int32 - response_time: - type: integer - format: int64 - is_proxy_call: - type: boolean - cache_status: - type: string - nullable: true - cache_type: - type: string - nullable: true - stream_mode: - type: integer - nullable: true - retry_success_count: - type: integer - trace_id: - type: string - span_id: - type: string - span_name: - type: string - parent_span_id: - type: string - mode: - type: string - virtual_key: - type: string - source: - type: string - runtime: - type: string - runtime_version: - type: string - sdk_version: - type: string - config: - type: string - internal_trace_id: - type: string - last_used_option_index: - type: integer - config_version_id: - type: string - prompt_slug: - type: string - workspace_slug: - type: string - nullable: true - log_store_file_path_format: - type: string - metadata.key: - type: array - items: - type: string - nullable: true - metadata.value: + data: type: array items: - type: string - nullable: true - api_key_id: - type: string - request_parsing_time: - type: integer - format: int64 - pre_processing_time: - type: integer - format: int64 - cache_processing_time: - type: integer - format: int64 - response_parsing_time: - type: integer - format: int64 - gateway_processing_time: - type: integer - format: int64 - upstream_response_time: + $ref: '#/components/schemas/GuardrailSummary' + total: type: integer - format: int64 - ApiKeyObject: + minimum: 0 + GuardrailSummary: type: object + required: + - id + - name + - slug + - created_at + - last_updated_at + - owner_id properties: - id: - type: string - format: uuid - key: + id: type: string name: type: string - description: + slug: type: string - type: + target: type: string enum: - - organisation-service - - workspace-service - - workspace-user + - llm + - mcp_tools + default: llm organisation_id: type: string format: uuid workspace_id: type: string - user_id: - type: string format: uuid + nullable: true status: type: string enum: - active - - exhausted + - archived created_at: type: string format: date-time last_updated_at: type: string format: date-time - creation_mode: - type: string - enum: - - ui - - api - - auto - rate_limits: - type: array - items: - type: object - properties: - type: - type: string - unit: - type: string - value: - type: integer - usage_limits: - $ref: '#/components/schemas/UsageLimits' - reset_usage: - type: number - scopes: - type: array - items: - type: string - defaults: - type: object - properties: - metadata: - type: object - additionalProperties: true - config_id: - type: string - alert_emails: - type: array - items: - type: string - format: email - expires_at: - type: string - format: date-time - object: + owner_id: type: string - enum: - - api-key - ApiKeyObjectList: - type: object - properties: - total: - type: integer - object: + format: uuid + updated_by: type: string - enum: - - list - data: - type: array - items: - $ref: '#/components/schemas/ApiKeyObject' - CreateApiKeyObject: + format: uuid + nullable: true + GuardrailDetails: + allOf: + - $ref: '#/components/schemas/GuardrailSummary' + - type: object + properties: + checks: + type: array + items: + $ref: '#/components/schemas/GuardrailCheck' + actions: + $ref: '#/components/schemas/GuardrailActions' + mcp_server_mappings: + type: array + items: + $ref: '#/components/schemas/McpServerMapping' + McpServerMapping: type: object required: - - name - - scopes + - id + - guardrail_id + - mcp_server_id + - run_on properties: - name: - type: string - description: - type: string - organisation_id: + id: type: string format: uuid - workspace_id: + guardrail_id: type: string - user_id: + format: uuid + mcp_server_id: type: string format: uuid - rate_limits: + run_on: + type: array + items: + type: string + enum: + - input + - output + minItems: 1 + capability_ids: type: array - nullable: true items: + type: string + format: uuid + BulkSyncMcpServerMappingsRequest: + type: object + required: + - mcp_servers + properties: + mcp_servers: + type: object + additionalProperties: type: object - required: - - type - - unit - - value properties: - type: - type: string - enum: - - requests - - tokens - unit: - type: string - enum: - - rpd - - rph - - rpm - - rps - - rpw - value: - type: integer - minimum: 0 - usage_limits: - $ref: '#/components/schemas/UsageLimits' - scopes: + run_on: + type: array + items: + type: string + enum: + - input + - output + minItems: 1 + default: + - input + - output + mcp_integration_capability_ids: + type: array + items: + type: string + format: uuid + BulkSyncMcpServerMappingsResponse: + type: object + required: + - changed + - added + - updated + - removed + properties: + changed: + type: boolean + added: + type: integer + minimum: 0 + updated: + type: integer + minimum: 0 + removed: + type: integer + minimum: 0 + UpsertMcpServerMappingRequest: + type: object + properties: + run_on: type: array items: type: string - defaults: - type: object - properties: - metadata: - type: object - additionalProperties: true - config_id: - type: string - allow_config_override: - type: boolean - default: true - alert_emails: + enum: + - input + - output + minItems: 1 + default: + - input + - output + mcp_integration_capability_ids: type: array items: type: string - format: email - expires_at: + format: uuid + UpsertMcpServerMappingResponse: + type: object + required: + - map_id + properties: + map_id: type: string - format: date-time - nullable: true - rotation_policy: - type: object - nullable: true - properties: - rotation_period: - type: string - enum: - - weekly - - monthly - nullable: true - next_rotation_at: - type: string - format: date-time - nullable: true - key_transition_period_ms: - type: integer - minimum: 1800000 - UpdateApiKeyObject: + format: uuid + JWTParameters: + title: JWT Parameters type: object + required: + - jwksUri + - headerKey properties: - name: + jwksUri: type: string - description: + format: uri + headerKey: + type: string + cacheMaxAge: + type: number + default: 86400 + clockTolerance: + type: number + default: 5 + maxTokenAge: type: string - rate_limits: + default: 1d + algorithms: type: array - nullable: true items: - type: object - required: - - type - - unit - - value - properties: - type: - type: string - enum: - - requests - - tokens - unit: - type: string - enum: - - rpd - - rph - - rpm - - rps - - rpw - value: - type: integer - minimum: 0 - usage_limits: - $ref: '#/components/schemas/UsageLimits' - reset_usage: + type: string + default: + - RS256 + RegexMatchParameters: + title: Regex Match Parameters + type: object + required: + - rule + properties: + rule: + type: string + not: type: boolean - scopes: + default: false + ModelWhitelistParameters: + title: Model Whitelist Parameters + type: object + required: + - models + properties: + models: type: array items: type: string - defaults: + WordCountParameters: + title: Word Count Parameters + type: object + properties: + minWords: + type: number + default: 0 + maxWords: + type: number + default: 99999 + not: + type: boolean + default: false + SentenceCountParameters: + title: Sentence Count Parameters + type: object + properties: + minSentences: + type: number + default: 0 + maxSentences: + type: number + default: 99999 + not: + type: boolean + default: false + CharacterCountParameters: + title: Character Count Parameters + type: object + properties: + minCharacters: + type: number + default: 0 + maxCharacters: + type: number + default: 9999999 + not: + type: boolean + default: false + JSONSchemaParameters: + title: JSON Schema Parameters + type: object + required: + - schema + properties: + schema: type: object - properties: - metadata: - type: object - additionalProperties: true - config_id: - type: string - allow_config_override: - type: boolean - default: true - alert_emails: + additionalProperties: true + not: + type: boolean + default: false + JSONKeysParameters: + title: JSON Keys Parameters + type: object + required: + - keys + - operator + properties: + keys: type: array items: type: string - format: email - expires_at: + operator: type: string - format: date-time - nullable: true - rotation_policy: - type: object - nullable: true - properties: - rotation_period: - type: string - enum: - - weekly - - monthly - nullable: true - next_rotation_at: - type: string - format: date-time - nullable: true - key_transition_period_ms: - type: integer - minimum: 1800000 - RotateApiKeyRequest: + enum: + - any + - all + - none + default: any + ContainsParameters: + title: Contains Parameters type: object + required: + - words + - operator properties: - key_transition_period_ms: - type: integer - minimum: 1800000 - RotateApiKeyResponse: + words: + type: array + items: + type: string + operator: + type: string + enum: + - any + - all + - none + default: any + ValidUrlsParameters: + title: Valid URLs Parameters type: object properties: - id: - type: string - format: uuid - key: - type: string - key_transition_expires_at: - type: string - format: date-time - CreateGuardrailRequest: + onlyDNS: + type: boolean + default: false + not: + type: boolean + default: false + ContainsCodeParameters: + title: Contains Code Parameters type: object required: - - name + - format properties: - name: - type: string - target: + format: type: string enum: - - llm - - mcp_tools - default: llm - workspace_id: - type: string - format: uuid - organisation_id: + - SQL + - Python + - TypeScript + - JavaScript + - Java + - C# + - C++ + - C + - Ruby + - PHP + - Swift + - Kotlin + - Go + - Rust + - Scala + - R + - Perl + - Shell + - HTML + - CSS + - XML + - JSON + - YAML + - Markdown + - Dockerfile + not: + type: boolean + default: false + WebhookParameters: + title: Webhook Parameters + type: object + required: + - webhookURL + properties: + webhookURL: type: string - format: uuid - checks: - type: array - items: - $ref: '#/components/schemas/GuardrailCheck' - minItems: 1 - actions: - $ref: '#/components/schemas/GuardrailActions' - UpdateGuardrailRequest: + format: uri + headers: + type: object + additionalProperties: true + timeout: + type: number + default: 3000 + failOnError: + type: boolean + default: false + EndsWithParameters: + title: Ends With Parameters type: object + required: + - suffix properties: - name: + suffix: type: string - checks: - type: array - items: - $ref: '#/components/schemas/GuardrailCheck' - minItems: 1 - actions: - $ref: '#/components/schemas/GuardrailActions' - GuardrailActions: - type: object - properties: - deny: + not: type: boolean default: false - async: + UppercaseParameters: + title: Uppercase Parameters + type: object + properties: + not: type: boolean default: false - on_success: - type: object - properties: - feedback: - type: object - properties: - value: - type: number - default: 5 - weight: - type: number - default: 1 - metadata: - type: string - default: '' - required: - - value - - weight - - metadata - required: - - feedback - on_fail: - type: object - properties: - feedback: - type: object - properties: - value: - type: number - default: -5 - weight: - type: number - default: 1 - metadata: - type: string - default: '' - required: - - value - - weight - - metadata - required: - - feedback - required: - - deny - - async - - on_success - - on_fail - GuardrailCheck: + RequiredMetadataKeysParameters: + title: Required Metadata Keys Parameters type: object required: - - id + - metadataKeys + - operator properties: - id: + metadataKeys: + type: array + items: + type: string + operator: type: string enum: - - default.jwt - - default.modelWhitelist - - default.isAllLowerCase - - default.regexMatch - - default.sentenceCount - - default.wordCount - - default.characterCount - - default.jsonSchema - - default.jsonKeys - - default.contains - - default.validUrls - - default.containsCode - - default.webhook - - default.endsWith - - default.alluppercase - - default.requiredMetadataKeys - - default.allowedRequestTypes - - portkey.moderateContent - - portkey.language - - portkey.pii - - portkey.gibberish - - sydelabs.sydeguard - - aporia.validateProject - - pillar.scanPrompt - - pillar.scanResponse - - patronus.phi - - patronus.pii - - patronus.isConcise - - patronus.isHelpful - - patronus.isPolite - - patronus.noApologies - - patronus.noGenderBias - - patronus.noRacialBias - - patronus.retrievalAnswerRelevance - - patronus.toxicity - - patronus.custom - - mistral.moderateContent - - bedrock.guard - - promptfoo.guard - - promptfoo.pii - - promptfoo.harm - - acuvity.scan - - lasso.classify - - azure.contentSafety - - azure.pii - - panw-prisma-airs.intercept - parameters: - oneOf: - - $ref: '#/components/schemas/JWTParameters' - - $ref: '#/components/schemas/ModelWhitelistParameters' - - $ref: '#/components/schemas/RegexMatchParameters' - - $ref: '#/components/schemas/SentenceCountParameters' - - $ref: '#/components/schemas/WordCountParameters' - - $ref: '#/components/schemas/CharacterCountParameters' - - $ref: '#/components/schemas/JSONSchemaParameters' - - $ref: '#/components/schemas/JSONKeysParameters' - - $ref: '#/components/schemas/ContainsParameters' - - $ref: '#/components/schemas/ValidUrlsParameters' - - $ref: '#/components/schemas/ContainsCodeParameters' - - $ref: '#/components/schemas/WebhookParameters' - - $ref: '#/components/schemas/EndsWithParameters' - - $ref: '#/components/schemas/UppercaseParameters' - - $ref: '#/components/schemas/RequiredMetadataKeysParameters' - - $ref: '#/components/schemas/AllowedRequestTypesParameters' - - $ref: '#/components/schemas/SydeGuardParameters' - - $ref: '#/components/schemas/AporiaParameters' - - $ref: '#/components/schemas/PillarScanParameters' - - $ref: '#/components/schemas/PatronusParameters' - - $ref: '#/components/schemas/PatronusCustomParameters' - - $ref: '#/components/schemas/PortkeyModerationParameters' - - $ref: '#/components/schemas/PortkeyLanguageParameters' - - $ref: '#/components/schemas/PortkeyPIIParameters' - - $ref: '#/components/schemas/MistralModerationParameters' - - $ref: '#/components/schemas/BedrockGuardParameters' - - $ref: '#/components/schemas/PromptfooParameters' - - $ref: '#/components/schemas/AcuvityScanParameters' - - $ref: '#/components/schemas/AzureContentSafetyParameters' - - $ref: '#/components/schemas/AzurePIIParameters' - - $ref: '#/components/schemas/PANWPrismaParameters' - - $ref: '#/components/schemas/BasicParameters' - name: - type: string - is_enabled: - type: boolean - default: true - CreateGuardrailResponse: + - all + - any + - none + default: all + AllowedRequestTypesParameters: + title: Allowed Request Types Parameters + type: object + properties: + allowedTypes: + type: array + items: + type: string + enum: + - complete + - chatComplete + - embed + - rerank + - moderate + - proxy + - imageGenerate + - createSpeech + - createTranscription + - createTranslation + - realtime + - uploadFile + - listFiles + - retrieveFile + - deleteFile + - retrieveFileContent + - createBatch + - retrieveBatch + - cancelBatch + - listBatches + - getBatchOutput + - listFinetunes + - createFinetune + - retrieveFinetune + - cancelFinetune + - createModelResponse + - getModelResponse + - deleteModelResponse + - listResponseInputItems + - messages + blockedTypes: + type: array + items: + type: string + enum: + - complete + - chatComplete + - embed + - rerank + - moderate + - proxy + - imageGenerate + - createSpeech + - createTranscription + - createTranslation + - realtime + - uploadFile + - listFiles + - retrieveFile + - deleteFile + - retrieveFileContent + - createBatch + - retrieveBatch + - cancelBatch + - listBatches + - getBatchOutput + - listFinetunes + - createFinetune + - retrieveFinetune + - cancelFinetune + - createModelResponse + - getModelResponse + - deleteModelResponse + - listResponseInputItems + - messages + SydeGuardParameters: + title: SydeGuard Parameters type: object - required: - - id - - slug - - version_id properties: - id: - type: string - slug: - type: string - version_id: - type: string - UpdateGuardrailResponse: + prompt_injection_threshold: + type: number + minimum: 0 + maximum: 1 + multipleOf: 0.01 + default: 0.5 + toxicity_threshold: + type: number + minimum: 0 + maximum: 1 + multipleOf: 0.01 + default: 0.5 + evasion_threshold: + type: number + minimum: 0 + maximum: 1 + multipleOf: 0.01 + default: 0.5 + timeout: + type: number + default: 5000 + AporiaParameters: + title: Aporia Parameters type: object required: - - id - - slug + - projectID properties: - id: - type: string - slug: - type: string - version_id: + projectID: type: string - ListGuardrailsResponse: + timeout: + type: number + default: 5000 + PillarScanParameters: + title: Pillar Scan Parameters type: object required: - - data - - total + - scanners properties: - data: + scanners: type: array items: - $ref: '#/components/schemas/GuardrailSummary' - total: - type: integer - minimum: 0 - GuardrailSummary: + type: string + enum: + - prompt_injection + - pii + - secrets + - toxic_language + - invisible_characters + timeout: + type: number + default: 5000 + PatronusParameters: + title: Patronus Parameters + type: object + properties: + redact: + type: boolean + default: false + timeout: + type: number + default: 5000 + PatronusCustomParameters: + title: Patronus Custom Parameters type: object required: - - id - - name - - slug - - created_at - - last_updated_at - - owner_id + - profile properties: - id: - type: string - name: - type: string - slug: - type: string - target: - type: string - enum: - - llm - - mcp_tools - default: llm - organisation_id: - type: string - format: uuid - workspace_id: - type: string - format: uuid - nullable: true - status: - type: string - enum: - - active - - archived - created_at: - type: string - format: date-time - last_updated_at: - type: string - format: date-time - owner_id: - type: string - format: uuid - updated_by: + profile: type: string - format: uuid - nullable: true - GuardrailDetails: - allOf: - - $ref: '#/components/schemas/GuardrailSummary' - - type: object - properties: - checks: - type: array - items: - $ref: '#/components/schemas/GuardrailCheck' - actions: - $ref: '#/components/schemas/GuardrailActions' - mcp_server_mappings: - type: array - items: - $ref: '#/components/schemas/McpServerMapping' - McpServerMapping: + timeout: + type: number + default: 15000 + PortkeyModerationParameters: + title: Portkey Moderation Parameters type: object required: - - id - - guardrail_id - - mcp_server_id - - run_on + - categories properties: - id: - type: string - format: uuid - guardrail_id: - type: string - format: uuid - mcp_server_id: - type: string - format: uuid - run_on: + categories: type: array items: type: string enum: - - input - - output - minItems: 1 - capability_ids: - type: array - items: - type: string - format: uuid - BulkSyncMcpServerMappingsRequest: + - hate + - hate/threatening + - harassment + - harassment/threatening + - self-harm + - self-harm/intent + - self-harm/instructions + - sexual + - sexual/minors + - violence + - violence/graphic + timeout: + type: number + default: 5000 + PortkeyLanguageParameters: + title: Portkey Language Parameters type: object - required: - - mcp_servers properties: - mcp_servers: - type: object - additionalProperties: - type: object - properties: - run_on: - type: array - items: - type: string - enum: - - input - - output - minItems: 1 - default: - - input - - output - mcp_integration_capability_ids: - type: array - items: - type: string - format: uuid - BulkSyncMcpServerMappingsResponse: + language: + type: string + enum: + - eng_Latn + - zho_Hans + - spa_Latn + - ara_Arab + - por_Latn + - ind_Latn + - fra_Latn + - jpn_Jpan + - rus_Cyrl + - deu_Latn + - kor_Hang + - tur_Latn + - ita_Latn + - pes_Arab + - pol_Latn + - vie_Latn + - nld_Latn + - hin_Deva + - tha_Thai + - heb_Hebr + - ben_Beng + - swe_Latn + - ces_Latn + - ron_Latn + - ell_Grek + - ukr_Cyrl + - dan_Latn + - fin_Latn + - nor_Latn + - hun_Latn + - cat_Latn + - bul_Cyrl + - msa_Latn + - hrv_Latn + - arb_Latn + - slk_Latn + - lit_Latn + - lav_Latn + - srp_Cyrl + - slv_Latn + - est_Latn + - urd_Arab + - fil_Latn + - aze_Latn + - tam_Taml + - tel_Telu + - mar_Deva + - kan_Knda + - fas_Arab + not: + type: boolean + default: false + timeout: + type: number + default: 5000 + PortkeyPIIParameters: + title: Portkey PII Parameters type: object required: - - changed - - added - - updated - - removed + - categories properties: - changed: + redact: type: boolean - added: - type: integer - minimum: 0 - updated: - type: integer - minimum: 0 - removed: - type: integer - minimum: 0 - UpsertMcpServerMappingRequest: - type: object - properties: - run_on: + default: false + categories: type: array items: type: string enum: - - input - - output - minItems: 1 - default: - - input - - output - mcp_integration_capability_ids: - type: array - items: - type: string - format: uuid - UpsertMcpServerMappingResponse: - type: object - required: - - map_id - properties: - map_id: - type: string - format: uuid - JWTParameters: - title: JWT Parameters + - EMAIL_ADDRESS + - PHONE_NUMBER + - LOCATION_ADDRESS + - NAME + - IP_ADDRESS + - CREDIT_CARD + - SSN + timeout: + type: number + default: 5000 + MistralModerationParameters: + title: Mistral Moderation Parameters type: object required: - - jwksUri - - headerKey + - categories properties: - jwksUri: - type: string - format: uri - headerKey: - type: string - cacheMaxAge: - type: number - default: 86400 - clockTolerance: - type: number - default: 5 - maxTokenAge: - type: string - default: 1d - algorithms: + categories: type: array items: type: string - default: - - RS256 - RegexMatchParameters: - title: Regex Match Parameters + enum: + - sexual + - hate_and_discrimination + - violence_and_threats + - dangerous_and_criminal_content + - selfharm + - health + - financial + - law + - pii + timeout: + type: number + default: 5000 + BedrockGuardParameters: + title: Bedrock Guard Parameters type: object required: - - rule + - guardrailVersion + - guardrailId properties: - rule: + guardrailVersion: type: string - not: + guardrailId: + type: string + redact: type: boolean default: false - ModelWhitelistParameters: - title: Model Whitelist Parameters + timeout: + type: number + default: 5000 + PromptfooParameters: + title: Promptfoo Parameters type: object - required: - - models properties: - models: - type: array - items: - type: string - WordCountParameters: - title: Word Count Parameters + redact: + type: boolean + default: false + timeout: + type: number + default: 5000 + AcuvityScanParameters: + title: Acuvity Scan Parameters type: object properties: - minWords: + prompt_injection: + type: boolean + default: true + prompt_injection_threshold: type: number - default: 0 - maxWords: + minimum: 0 + maximum: 1 + multipleOf: 0.01 + default: 0.5 + toxic: + type: boolean + default: true + toxic_threshold: type: number - default: 99999 - not: + minimum: 0 + maximum: 1 + multipleOf: 0.01 + default: 0.5 + jail_break: type: boolean - default: false - SentenceCountParameters: - title: Sentence Count Parameters - type: object - properties: - minSentences: + default: true + jail_break_threshold: type: number - default: 0 - maxSentences: + minimum: 0 + maximum: 1 + multipleOf: 0.01 + default: 0.5 + malicious_url: + type: boolean + default: true + malicious_url_threshold: type: number - default: 99999 - not: + minimum: 0 + maximum: 1 + multipleOf: 0.01 + default: 0.5 + biased: type: boolean - default: false - CharacterCountParameters: - title: Character Count Parameters - type: object - properties: - minCharacters: + default: true + biased_threshold: type: number - default: 0 - maxCharacters: + minimum: 0 + maximum: 1 + multipleOf: 0.01 + default: 0.5 + harmful: + type: boolean + default: true + harmful_threshold: type: number - default: 9999999 - not: + minimum: 0 + maximum: 1 + multipleOf: 0.01 + default: 0.5 + language: + type: boolean + default: true + language_values: + type: string + enum: + - english + - chinese + - spanish + - french + - german + - japanese + - gibberish + default: english + pii: + type: boolean + default: true + pii_redact: type: boolean default: false - JSONSchemaParameters: - title: JSON Schema Parameters - type: object - required: - - schema - properties: - schema: - type: object - additionalProperties: true - not: + pii_categories: + type: array + items: + type: string + enum: + - email_address + - ssn + - person + - aba_routing_number + - address + - bank_account + - bitcoin_wallet + - credit_card + - driver_license + - itin_number + - location + - medical_license + - money_amount + - passport_number + - phone_number + secrets: + type: boolean + default: true + secrets_redact: type: boolean default: false - JSONKeysParameters: - title: JSON Keys Parameters + secrets_categories: + type: array + items: + type: string + enum: + - credentials + - aws_secret_key + - github + - openai + - stripe + - jwt + - private_key + timeout: + type: number + default: 5000 + AzureContentSafetyParameters: + title: Azure Content Safety Parameters type: object - required: - - keys - - operator properties: - keys: + blocklistNames: type: array items: type: string - operator: + default: [] + apiVersion: type: string - enum: - - any - - all - - none - default: any - ContainsParameters: - title: Contains Parameters - type: object - required: - - words - - operator - properties: - words: + default: '2024-09-01' + severity: + type: number + default: 2 + categories: type: array items: type: string - operator: + enum: + - Hate + - SelfHarm + - Sexual + - Violence + timeout: + type: number + default: 5000 + AzurePIIParameters: + title: Azure PII Parameters + type: object + properties: + domain: type: string enum: - - any - - all - none - default: any - ValidUrlsParameters: - title: Valid URLs Parameters - type: object - properties: - onlyDNS: - type: boolean - default: false - not: + - phi + default: none + apiVersion: + type: string + default: '2024-11-01' + modelVersion: + type: string + default: latest + redact: type: boolean default: false - ContainsCodeParameters: - title: Contains Code Parameters + timeout: + type: number + default: 5000 + PANWPrismaParameters: + title: PANW Prisma Parameters type: object required: - - format + - profile_name properties: - format: + profile_name: type: string - enum: - - SQL - - Python - - TypeScript - - JavaScript - - Java - - C# - - C++ - - C - - Ruby - - PHP - - Swift - - Kotlin - - Go - - Rust - - Scala - - R - - Perl - - Shell - - HTML - - CSS - - XML - - JSON - - YAML - - Markdown - - Dockerfile - not: - type: boolean - default: false - WebhookParameters: - title: Webhook Parameters + ai_model: + type: string + app_user: + type: string + BasicParameters: + title: Basic Parameters + type: object + additionalProperties: true + BedrockBatchJob: type: object required: - - webhookURL + - model + - role_arn properties: - webhookURL: + job_name: type: string - format: uri - headers: + output_data_config: + type: string + model: + type: string + role_arn: + type: string + allOf: + - $ref: '#/components/schemas/OpenAIBatchJob' + title: Bedrock Params + OpenAIBatchJob: + type: object + required: + - input_file_id + - completion_window + - endpoint + properties: + input_file_id: + type: string + completion_window: + type: string + enum: + - immediate + - 24h + endpoint: + type: string + enum: + - /v1/chat/completions + - /v1/completions + - /v1/embeddings + metadata: type: object additionalProperties: true - timeout: - type: number - default: 3000 - failOnError: - type: boolean - default: false - EndsWithParameters: - title: Ends With Parameters + nullable: true + title: OpenAI Params + PortkeyBatchJob: type: object required: - - suffix + - model properties: - suffix: + job_name: type: string - not: - type: boolean - default: false - UppercaseParameters: - title: Uppercase Parameters + output_data_config: + type: string + model: + type: string + role_arn: + type: string + portkey_options: + allOf: + - $ref: '#/components/schemas/PortkeyBatchOptions' + provider_options: + anyOf: + - type: object + title: Bedrock Options + properties: + job_name: + type: string + output_data_config: + type: string + model: + type: string + role_arn: + type: string + required: + - model + - role_arn + - type: object + title: Vertex Options + properties: + job_name: + type: string + output_data_config: + type: string + model: + type: string + required: + - model + allOf: + - $ref: '#/components/schemas/OpenAIBatchJob' + title: Portkey Params + PortkeyBatchOptions: + type: object + required: + - x-portkey-virtual-key + properties: + x-portkey-virtual-key: + type: string + x-portkey-aws-s3-bucket: + type: string + x-portkey-vertex-storage-bucket-name: + type: string + x-portkey-provider-model: + type: string + VertexBatchJob: + type: object + required: + - model + properties: + job_name: + type: string + output_data_config: + type: string + model: + type: string + allOf: + - $ref: '#/components/schemas/OpenAIBatchJob' + title: Vertex Params + Condition: type: object + required: + - key + - value properties: - not: - type: boolean - default: false - RequiredMetadataKeysParameters: - title: Required Metadata Keys Parameters + key: + type: string + value: + oneOf: + - type: string + - type: array + items: + type: string + excludes: + oneOf: + - type: string + - type: array + items: + type: string + GroupBy: type: object required: - - metadataKeys - - operator + - key properties: - metadataKeys: - type: array - items: - type: string - operator: + key: type: string - enum: - - all - - any - - none - default: all - AllowedRequestTypesParameters: - title: Allowed Request Types Parameters + CreateUsageLimitsPolicyRequest: type: object + required: + - conditions + - group_by + - type + - credit_limit properties: - allowedTypes: + name: + type: string + maxLength: 255 + conditions: type: array + minItems: 1 items: - type: string - enum: - - complete - - chatComplete - - embed - - rerank - - moderate - - proxy - - imageGenerate - - createSpeech - - createTranscription - - createTranslation - - realtime - - uploadFile - - listFiles - - retrieveFile - - deleteFile - - retrieveFileContent - - createBatch - - retrieveBatch - - cancelBatch - - listBatches - - getBatchOutput - - listFinetunes - - createFinetune - - retrieveFinetune - - cancelFinetune - - createModelResponse - - getModelResponse - - deleteModelResponse - - listResponseInputItems - - messages - blockedTypes: + $ref: '#/components/schemas/Condition' + group_by: type: array + minItems: 1 items: - type: string - enum: - - complete - - chatComplete - - embed - - rerank - - moderate - - proxy - - imageGenerate - - createSpeech - - createTranscription - - createTranslation - - realtime - - uploadFile - - listFiles - - retrieveFile - - deleteFile - - retrieveFileContent - - createBatch - - retrieveBatch - - cancelBatch - - listBatches - - getBatchOutput - - listFinetunes - - createFinetune - - retrieveFinetune - - cancelFinetune - - createModelResponse - - getModelResponse - - deleteModelResponse - - listResponseInputItems - - messages - SydeGuardParameters: - title: SydeGuard Parameters - type: object - properties: - prompt_injection_threshold: + $ref: '#/components/schemas/GroupBy' + type: + type: string + enum: + - cost + - tokens + credit_limit: type: number minimum: 0 - maximum: 1 - multipleOf: 0.01 - default: 0.5 - toxicity_threshold: + alert_threshold: type: number + nullable: true minimum: 0 - maximum: 1 - multipleOf: 0.01 - default: 0.5 - evasion_threshold: + periodic_reset: + type: string + nullable: true + enum: + - monthly + - weekly + workspace_id: + type: string + organisation_id: + type: string + format: uuid + UpdateUsageLimitsPolicyRequest: + type: object + properties: + name: + type: string + maxLength: 255 + description: + type: string + nullable: true + maxLength: 500 + conditions: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/Condition' + credit_limit: type: number minimum: 0 - maximum: 1 - multipleOf: 0.01 - default: 0.5 - timeout: + alert_threshold: type: number - default: 5000 - AporiaParameters: - title: Aporia Parameters + nullable: true + minimum: 0 + periodic_reset: + type: string + nullable: true + enum: + - monthly + - weekly + periodic_reset_days: + type: integer + nullable: true + minimum: 1 + maximum: 365 + next_usage_reset_at: + type: string + format: date-time + nullable: true + reset_usage_for_value: + type: string + CreateRateLimitsPolicyRequest: type: object required: - - projectID + - conditions + - group_by + - type + - unit + - value properties: - projectID: + name: type: string - timeout: + maxLength: 255 + conditions: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/Condition' + group_by: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/GroupBy' + type: + type: string + enum: + - requests + - tokens + unit: + type: string + enum: + - rpm + - rph + - rpd + - rpw + value: + type: number + target: + type: string + enum: + - llm + - mcp_tools + default: llm + workspace_id: + type: string + organisation_id: + type: string + format: uuid + UpdateRateLimitsPolicyRequest: + type: object + properties: + name: + type: string + maxLength: 255 + unit: + type: string + enum: + - rpm + - rph + - rpd + - rpw + value: type: number - default: 5000 - PillarScanParameters: - title: Pillar Scan Parameters + conditions: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/Condition' + UsageLimitsPolicy: type: object required: - - scanners + - id + - type + - status + - workspace_id + - organisation_id + - created_at + - last_updated_at properties: - scanners: + id: + type: string + format: uuid + name: + type: string + nullable: true + conditions: type: array items: - type: string - enum: - - prompt_injection - - pii - - secrets - - toxic_language - - invisible_characters - timeout: + $ref: '#/components/schemas/Condition' + group_by: + type: array + items: + $ref: '#/components/schemas/GroupBy' + type: + type: string + enum: + - cost + - tokens + credit_limit: type: number - default: 5000 - PatronusParameters: - title: Patronus Parameters - type: object - properties: - redact: - type: boolean - default: false - timeout: + alert_threshold: type: number - default: 5000 - PatronusCustomParameters: - title: Patronus Custom Parameters + nullable: true + periodic_reset: + type: string + nullable: true + enum: + - monthly + - weekly + periodic_reset_days: + type: integer + nullable: true + minimum: 1 + maximum: 365 + next_usage_reset_at: + type: string + format: date-time + nullable: true + last_reset_at: + type: string + format: date-time + nullable: true + status: + type: string + enum: + - active + - archived + workspace_id: + type: string + format: uuid + organisation_id: + type: string + format: uuid + created_at: + type: string + format: date-time + last_updated_at: + type: string + format: date-time + value_key_usage_map: + type: object + additionalProperties: + $ref: '#/components/schemas/ValueKeyUsage' + ValueKeyUsage: type: object - required: - - profile properties: - profile: - type: string - timeout: + current_usage: type: number - default: 15000 - PortkeyModerationParameters: - title: Portkey Moderation Parameters + status: + type: string + enum: + - active + - exhausted + is_threshold_alerts_sent: + type: boolean + is_exhausted_alerts_sent: + type: boolean + RateLimitsPolicy: type: object required: - - categories + - id + - type + - unit + - value + - status + - workspace_id + - organisation_id + - created_at + - last_updated_at properties: - categories: + id: + type: string + format: uuid + name: + type: string + nullable: true + conditions: type: array items: - type: string - enum: - - hate - - hate/threatening - - harassment - - harassment/threatening - - self-harm - - self-harm/intent - - self-harm/instructions - - sexual - - sexual/minors - - violence - - violence/graphic - timeout: - type: number - default: 5000 - PortkeyLanguageParameters: - title: Portkey Language Parameters - type: object - properties: - language: + $ref: '#/components/schemas/Condition' + group_by: + type: array + items: + $ref: '#/components/schemas/GroupBy' + type: type: string enum: - - eng_Latn - - zho_Hans - - spa_Latn - - ara_Arab - - por_Latn - - ind_Latn - - fra_Latn - - jpn_Jpan - - rus_Cyrl - - deu_Latn - - kor_Hang - - tur_Latn - - ita_Latn - - pes_Arab - - pol_Latn - - vie_Latn - - nld_Latn - - hin_Deva - - tha_Thai - - heb_Hebr - - ben_Beng - - swe_Latn - - ces_Latn - - ron_Latn - - ell_Grek - - ukr_Cyrl - - dan_Latn - - fin_Latn - - nor_Latn - - hun_Latn - - cat_Latn - - bul_Cyrl - - msa_Latn - - hrv_Latn - - arb_Latn - - slk_Latn - - lit_Latn - - lav_Latn - - srp_Cyrl - - slv_Latn - - est_Latn - - urd_Arab - - fil_Latn - - aze_Latn - - tam_Taml - - tel_Telu - - mar_Deva - - kan_Knda - - fas_Arab - not: - type: boolean - default: false - timeout: + - requests + - tokens + unit: + type: string + enum: + - rpm + - rph + - rpd + - rpw + value: type: number - default: 5000 - PortkeyPIIParameters: - title: Portkey PII Parameters - type: object - required: - - categories + status: + type: string + enum: + - active + - archived + workspace_id: + type: string + format: uuid + organisation_id: + type: string + format: uuid + created_at: + type: string + format: date-time + last_updated_at: + type: string + format: date-time + target: + type: string + enum: + - llm + - mcp_tools + default: llm + CreatePolicyResponse: + type: object properties: - redact: - type: boolean - default: false - categories: - type: array - items: - type: string - enum: - - EMAIL_ADDRESS - - PHONE_NUMBER - - LOCATION_ADDRESS - - NAME - - IP_ADDRESS - - CREDIT_CARD - - SSN - timeout: - type: number - default: 5000 - MistralModerationParameters: - title: Mistral Moderation Parameters + id: + type: string + format: uuid + object: + type: string + UsageLimitsPolicyListResponse: type: object - required: - - categories properties: - categories: + object: + type: string + data: type: array items: + $ref: '#/components/schemas/UsageLimitsPolicy' + total: + type: integer + UsageLimitsPolicyResponse: + allOf: + - $ref: '#/components/schemas/UsageLimitsPolicy' + - type: object + properties: + object: type: string - enum: - - sexual - - hate_and_discrimination - - violence_and_threats - - dangerous_and_criminal_content - - selfharm - - health - - financial - - law - - pii - timeout: - type: number - default: 5000 - BedrockGuardParameters: - title: Bedrock Guard Parameters + UsageLimitsPolicyEntity: type: object - required: - - guardrailVersion - - guardrailId properties: - guardrailVersion: + id: type: string - guardrailId: + value_key: type: string - redact: - type: boolean - default: false - timeout: - type: number - default: 5000 - PromptfooParameters: - title: Promptfoo Parameters - type: object - properties: - redact: - type: boolean - default: false - timeout: + current_usage: type: number - default: 5000 - AcuvityScanParameters: - title: Acuvity Scan Parameters + UsageLimitsPolicyEntityListResponse: type: object properties: - prompt_injection: - type: boolean - default: true - prompt_injection_threshold: - type: number - minimum: 0 - maximum: 1 - multipleOf: 0.01 - default: 0.5 - toxic: - type: boolean - default: true - toxic_threshold: - type: number - minimum: 0 - maximum: 1 - multipleOf: 0.01 - default: 0.5 - jail_break: - type: boolean - default: true - jail_break_threshold: - type: number - minimum: 0 - maximum: 1 - multipleOf: 0.01 - default: 0.5 - malicious_url: - type: boolean - default: true - malicious_url_threshold: - type: number - minimum: 0 - maximum: 1 - multipleOf: 0.01 - default: 0.5 - biased: - type: boolean - default: true - biased_threshold: - type: number - minimum: 0 - maximum: 1 - multipleOf: 0.01 - default: 0.5 - harmful: - type: boolean - default: true - harmful_threshold: - type: number - minimum: 0 - maximum: 1 - multipleOf: 0.01 - default: 0.5 - language: - type: boolean - default: true - language_values: + object: type: string - enum: - - english - - chinese - - spanish - - french - - german - - japanese - - gibberish - default: english - pii: - type: boolean - default: true - pii_redact: - type: boolean - default: false - pii_categories: - type: array - items: - type: string - enum: - - email_address - - ssn - - person - - aba_routing_number - - address - - bank_account - - bitcoin_wallet - - credit_card - - driver_license - - itin_number - - location - - medical_license - - money_amount - - passport_number - - phone_number - secrets: - type: boolean - default: true - secrets_redact: - type: boolean - default: false - secrets_categories: + data: type: array items: - type: string - enum: - - credentials - - aws_secret_key - - github - - openai - - stripe - - jwt - - private_key - timeout: - type: number - default: 5000 - AzureContentSafetyParameters: - title: Azure Content Safety Parameters + $ref: '#/components/schemas/UsageLimitsPolicyEntity' + total: + type: integer + RateLimitsPolicyListResponse: type: object properties: - blocklistNames: + object: + type: string + data: type: array items: + $ref: '#/components/schemas/RateLimitsPolicy' + total: + type: integer + RateLimitsPolicyResponse: + allOf: + - $ref: '#/components/schemas/RateLimitsPolicy' + - type: object + properties: + object: type: string - default: [] - apiVersion: + CreateMcpIntegration: + type: object + required: + - name + - url + - auth_type + - transport + properties: + organisation_id: + type: string + format: uuid + workspace_id: + type: string + format: uuid + slug: + type: string + pattern: ^[a-zA-Z0-9_-]+$ + name: + type: string + description: + type: string + nullable: true + configurations: + type: object + properties: + custom_headers: + type: object + additionalProperties: true + passthrough_header: + type: object + additionalProperties: true + additionalProperties: true + url: + type: string + format: uri + auth_type: + type: string + enum: + - oauth_auto + - headers + - none + transport: type: string - default: '2024-09-01' - severity: - type: number - default: 2 - categories: + enum: + - http + - sse + secret_mappings: type: array items: - type: string - enum: - - Hate - - SelfHarm - - Sexual - - Violence - timeout: - type: number - default: 5000 - AzurePIIParameters: - title: Azure PII Parameters + $ref: '#/components/schemas/SecretMapping' + McpIntegrationCreateResponse: type: object properties: - domain: + id: + type: string + format: uuid + slug: + type: string + McpIntegration: + type: object + properties: + id: + type: string + format: uuid + name: + type: string + description: + type: string + nullable: true + owner_id: + type: string + status: + type: string + created_at: + type: string + format: date-time + last_updated_at: + type: string + format: date-time + configurations: + type: object + nullable: true + global_workspace_access: + type: object + nullable: true + workspace_id: + type: string + nullable: true + slug: + type: string + url: + type: string + format: uri + auth_type: type: string enum: + - oauth_auto + - oauth_client_credentials + - headers - none - - phi - default: none - apiVersion: + transport: type: string - default: '2024-11-01' - modelVersion: + enum: + - http + - sse + - interactive + type: type: string - default: latest - redact: - type: boolean - default: false - timeout: - type: number - default: 5000 - PANWPrismaParameters: - title: PANW Prisma Parameters + enum: + - workspace + - organisation + secret_mappings: + type: array + items: + $ref: '#/components/schemas/SecretMapping' + McpIntegrationListItem: type: object - required: - - profile_name properties: - profile_name: + id: type: string - ai_model: + format: uuid + name: type: string - app_user: + owner_id: type: string - BasicParameters: - title: Basic Parameters + status: + type: string + type: + type: string + enum: + - workspace + - organisation + url: + type: string + format: uri + auth_type: + type: string + enum: + - oauth_auto + - headers + - none + transport: + type: string + enum: + - http + - sse + - interactive + configurations: + type: object + created_at: + type: string + format: date-time + last_updated_at: + type: string + format: date-time + slug: + type: string + workspace_id: + type: string + nullable: true + description: + type: string + nullable: true + workspaces_count: + type: number + nullable: true + secret_mappings: + type: array + items: + $ref: '#/components/schemas/SecretMapping' + McpIntegrationListResponse: type: object - additionalProperties: true - BedrockBatchJob: + properties: + data: + type: array + items: + $ref: '#/components/schemas/McpIntegrationListItem' + total: + type: integer + has_more: + type: boolean + UpdateMcpIntegration: type: object - required: - - model - - role_arn + minProperties: 1 properties: - job_name: + name: type: string - output_data_config: + description: type: string - model: + nullable: true + configurations: + type: object + properties: + custom_headers: + type: object + additionalProperties: true + passthrough_header: + type: object + additionalProperties: true + additionalProperties: true + url: type: string - role_arn: + format: uri + auth_type: type: string - allOf: - - $ref: '#/components/schemas/OpenAIBatchJob' - title: Bedrock Params - OpenAIBatchJob: + enum: + - oauth_auto + - headers + - none + transport: + type: string + enum: + - http + - sse + secret_mappings: + type: array + items: + $ref: '#/components/schemas/SecretMapping' + McpIntegrationWorkspaceItem: type: object - required: - - input_file_id - - completion_window - - endpoint properties: - input_file_id: + id: type: string - completion_window: + enabled: + type: boolean + status: type: string - enum: - - immediate - - 24h - endpoint: + created_at: type: string - enum: - - /v1/chat/completions - - /v1/completions - - /v1/embeddings - metadata: + format: date-time + last_updated_at: + type: string + format: date-time + McpIntegrationWorkspacesListResponse: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/McpIntegrationWorkspaceItem' + global_workspace_access: + type: object + nullable: true + total: + type: integer + McpIntegrationWorkspacesLegacyResponse: + type: object + properties: + workspaces: + type: array + items: + $ref: '#/components/schemas/McpIntegrationWorkspaceItem' + global_workspace_access: type: object - additionalProperties: true nullable: true - title: OpenAI Params - PortkeyBatchJob: + BulkUpdateMcpIntegrationWorkspaces: type: object required: - - model + - workspaces properties: - job_name: - type: string - output_data_config: - type: string - model: - type: string - role_arn: - type: string - portkey_options: - allOf: - - $ref: '#/components/schemas/PortkeyBatchOptions' - provider_options: - anyOf: - - type: object - title: Bedrock Options - properties: - job_name: - type: string - output_data_config: - type: string - model: - type: string - role_arn: - type: string + workspaces: + type: array + minItems: 0 + items: + type: object required: - - model - - role_arn - - type: object - title: Vertex Options + - id + - enabled properties: - job_name: - type: string - output_data_config: - type: string - model: + id: type: string - required: - - model - allOf: - - $ref: '#/components/schemas/OpenAIBatchJob' - title: Portkey Params - PortkeyBatchOptions: + enabled: + type: boolean + global_workspace_access: + type: object + nullable: true + properties: + enabled: + type: boolean + override_existing_workspace_access: + type: boolean + default: false + McpIntegrationCapabilityItem: type: object - required: - - x-portkey-virtual-key properties: - x-portkey-virtual-key: + name: type: string - x-portkey-aws-s3-bucket: + type: type: string - x-portkey-vertex-storage-bucket-name: + enum: + - tool + - prompt + - resource + - resource_template + title: type: string - x-portkey-provider-model: + nullable: true + description: type: string - VertexBatchJob: - type: object - required: - - model - properties: - job_name: + nullable: true + icons: + type: array + nullable: true + enabled: + type: boolean + created_at: type: string - output_data_config: + format: date-time + last_updated_at: type: string - model: + format: date-time + input_schema: + type: object + nullable: true + output_schema: + type: object + nullable: true + execution: + type: object + nullable: true + annotations: + type: object + nullable: true + arguments: + type: array + nullable: true + uri: type: string - allOf: - - $ref: '#/components/schemas/OpenAIBatchJob' - title: Vertex Params - Condition: - type: object - required: - - key - - value - properties: - key: + nullable: true + uri_template: type: string - value: - oneOf: - - type: string - - type: array - items: - type: string - excludes: - oneOf: - - type: string - - type: array - items: - type: string - GroupBy: + nullable: true + mime_type: + type: string + nullable: true + size: + type: number + nullable: true + McpIntegrationCapabilitiesCounts: type: object - required: - - key properties: - key: - type: string - CreateUsageLimitsPolicyRequest: + tools: + type: object + properties: + total: + type: integer + enabled: + type: integer + prompts: + type: object + properties: + total: + type: integer + enabled: + type: integer + resources: + type: object + properties: + total: + type: integer + enabled: + type: integer + resource_templates: + type: object + properties: + total: + type: integer + enabled: + type: integer + McpIntegrationCapabilitiesListResponse: type: object - required: - - conditions - - group_by - - type - - credit_limit properties: - name: - type: string - maxLength: 255 - conditions: + data: type: array - minItems: 1 items: - $ref: '#/components/schemas/Condition' - group_by: + $ref: '#/components/schemas/McpIntegrationCapabilityItem' + counts: + $ref: '#/components/schemas/McpIntegrationCapabilitiesCounts' + total: + type: integer + has_more: + type: boolean + BulkUpdateMcpIntegrationCapabilities: + type: object + required: + - capabilities + properties: + capabilities: type: array minItems: 1 items: - $ref: '#/components/schemas/GroupBy' - type: - type: string - enum: - - cost - - tokens - credit_limit: - type: number - minimum: 0 - alert_threshold: - type: number - nullable: true - minimum: 0 - periodic_reset: - type: string - nullable: true - enum: - - monthly - - weekly - workspace_id: - type: string - organisation_id: - type: string - format: uuid - UpdateUsageLimitsPolicyRequest: + type: object + required: + - name + - type + - enabled + properties: + name: + type: string + type: + type: string + enum: + - tool + - prompt + - resource + enabled: + type: boolean + McpIntegrationCapabilitiesBulkUpdateResponse: type: object properties: - name: - type: string - maxLength: 255 - description: + success: + type: boolean + McpIntegrationMetadata: + type: object + properties: + server_name: type: string nullable: true - maxLength: 500 - conditions: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/Condition' - credit_limit: - type: number - minimum: 0 - alert_threshold: - type: number + server_version: + type: string nullable: true - minimum: 0 - periodic_reset: + protocol_version: type: string nullable: true - enum: - - monthly - - weekly - periodic_reset_days: - type: integer + capability_flags: + type: object nullable: true - minimum: 1 - maximum: 365 - next_usage_reset_at: + sync_status: + type: string + nullable: true + last_synced_at: type: string format: date-time nullable: true - reset_usage_for_value: + sync_error: type: string - CreateRateLimitsPolicyRequest: + nullable: true + CreateMcpServer: type: object required: - - conditions - - group_by - - type - - unit - - value + - name + - mcp_integration_id properties: + workspace_id: + type: string + format: uuid name: type: string + minLength: 1 maxLength: 255 - conditions: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/Condition' - group_by: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/GroupBy' - type: - type: string - enum: - - requests - - tokens - unit: - type: string - enum: - - rpm - - rph - - rpd - - rpw - value: - type: number - target: + description: type: string - enum: - - llm - - mcp_tools - default: llm - workspace_id: + nullable: true + maxLength: 500 + mcp_integration_id: type: string - organisation_id: + slug: type: string - format: uuid - UpdateRateLimitsPolicyRequest: + pattern: ^[a-zA-Z0-9_-]+$ + minLength: 3 + maxLength: 50 + McpServerCreateResponse: type: object properties: - name: + id: type: string - maxLength: 255 - unit: + format: uuid + slug: type: string - enum: - - rpm - - rph - - rpd - - rpw - value: - type: number - conditions: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/Condition' - UsageLimitsPolicy: + McpServer: type: object - required: - - id - - type - - status - - workspace_id - - organisation_id - - created_at - - last_updated_at properties: id: type: string format: uuid - name: - type: string - nullable: true - conditions: - type: array - items: - $ref: '#/components/schemas/Condition' - group_by: - type: array - items: - $ref: '#/components/schemas/GroupBy' - type: - type: string - enum: - - cost - - tokens - credit_limit: - type: number - alert_threshold: - type: number - nullable: true - periodic_reset: - type: string - nullable: true - enum: - - monthly - - weekly - periodic_reset_days: - type: integer - nullable: true - minimum: 1 - maximum: 365 - next_usage_reset_at: + slug: type: string - format: date-time - nullable: true - last_reset_at: + name: type: string - format: date-time - nullable: true status: type: string - enum: - - active - - archived - workspace_id: - type: string - format: uuid - organisation_id: + description: type: string - format: uuid + nullable: true created_at: type: string format: date-time - last_updated_at: + mcp_integration_id: type: string - format: date-time - value_key_usage_map: + mcp_integration_details: type: object - additionalProperties: - $ref: '#/components/schemas/ValueKeyUsage' - ValueKeyUsage: - type: object - properties: - current_usage: - type: number - status: + nullable: true + properties: + id: + type: string + slug: + type: string + status: + type: string + configurations: + type: object + nullable: true + url: + type: string + format: uri + transport: + type: string + auth_type: + type: string + workspace_id: type: string - enum: - - active - - exhausted - is_threshold_alerts_sent: - type: boolean - is_exhausted_alerts_sent: - type: boolean - RateLimitsPolicy: + nullable: true + McpServerListItem: type: object - required: - - id - - type - - unit - - value - - status - - workspace_id - - organisation_id - - created_at - - last_updated_at properties: id: type: string format: uuid + organisation_id: + type: string name: type: string + description: + type: string nullable: true - conditions: - type: array - items: - $ref: '#/components/schemas/Condition' - group_by: - type: array - items: - $ref: '#/components/schemas/GroupBy' - type: + status: type: string - enum: - - requests - - tokens - unit: + created_at: type: string - enum: - - rpm - - rph - - rpd - - rpw - value: - type: number - status: + format: date-time + owner_id: + type: string + slug: type: string - enum: - - active - - archived workspace_id: type: string - format: uuid - organisation_id: + nullable: true + mcp_integration_id: + type: string + mcp_integration_slug: type: string - format: uuid - created_at: + nullable: true + mcp_integration_url: type: string - format: date-time - last_updated_at: + format: uri + nullable: true + auth_type: type: string - format: date-time - target: + workspace_name: type: string - enum: - - llm - - mcp_tools - default: llm - CreatePolicyResponse: - type: object - properties: - id: + nullable: true + workspace_slug: type: string - format: uuid - object: + nullable: true + url: type: string - UsageLimitsPolicyListResponse: + format: uri + McpServerListResponse: type: object properties: - object: - type: string data: type: array items: - $ref: '#/components/schemas/UsageLimitsPolicy' + $ref: '#/components/schemas/McpServerListItem' total: type: integer - UsageLimitsPolicyResponse: - allOf: - - $ref: '#/components/schemas/UsageLimitsPolicy' - - type: object - properties: - object: - type: string - UsageLimitsPolicyEntity: + UpdateMcpServer: type: object + minProperties: 1 properties: - id: + name: type: string - value_key: + minLength: 1 + maxLength: 255 + description: type: string - current_usage: - type: number - UsageLimitsPolicyEntityListResponse: + nullable: true + maxLength: 500 + McpServerTestResponse: type: object properties: - object: - type: string - data: - type: array - items: - $ref: '#/components/schemas/UsageLimitsPolicyEntity' - total: + success: + type: boolean + status_code: type: integer - RateLimitsPolicyListResponse: + nullable: true + response_time_ms: + type: integer + nullable: true + url: + type: string + format: uri + nullable: true + server_name: + type: string + error: + type: string + nullable: true + McpServerCapabilityItem: type: object properties: - object: + name: + type: string + type: + type: string + enum: + - tool + - prompt + - resource + - resource_template + title: + type: string + nullable: true + description: + type: string + nullable: true + icons: + type: array + nullable: true + enabled: + type: boolean + integration_enabled: + type: boolean + nullable: true + input_schema: + type: object + nullable: true + output_schema: + type: object + nullable: true + execution: + type: object + nullable: true + annotations: + type: object + nullable: true + arguments: + type: array + nullable: true + uri: + type: string + nullable: true + uri_template: type: string + nullable: true + mime_type: + type: string + nullable: true + size: + type: number + nullable: true + McpServerCapabilitiesCounts: + type: object + properties: + tools: + type: object + properties: + total: + type: integer + enabled: + type: integer + prompts: + type: object + properties: + total: + type: integer + enabled: + type: integer + resources: + type: object + properties: + total: + type: integer + enabled: + type: integer + resource_templates: + type: object + properties: + total: + type: integer + enabled: + type: integer + McpServerCapabilitiesListResponse: + type: object + properties: data: type: array items: - $ref: '#/components/schemas/RateLimitsPolicy' + $ref: '#/components/schemas/McpServerCapabilityItem' + counts: + $ref: '#/components/schemas/McpServerCapabilitiesCounts' total: type: integer - RateLimitsPolicyResponse: - allOf: - - $ref: '#/components/schemas/RateLimitsPolicy' - - type: object - properties: - object: - type: string - CreateMcpIntegration: + has_more: + type: boolean + BulkUpdateMcpServerCapabilities: type: object required: - - name - - url - - auth_type - - transport + - capabilities properties: - organisation_id: - type: string - format: uuid - workspace_id: - type: string - format: uuid - slug: - type: string - pattern: ^[a-zA-Z0-9_-]+$ - name: + capabilities: + type: array + minItems: 1 + items: + type: object + required: + - name + - type + - enabled + properties: + name: + type: string + type: + type: string + enum: + - tool + - prompt + - resource + enabled: + type: boolean + McpServerCapabilitiesBulkUpdateResponse: + type: object + properties: + success: + type: boolean + McpServerUserAccessItem: + type: object + properties: + user_id: type: string - description: + first_name: type: string nullable: true - configurations: - type: object - properties: - custom_headers: - type: object - additionalProperties: true - passthrough_header: - type: object - additionalProperties: true - additionalProperties: true - url: + last_name: type: string - format: uri - auth_type: + nullable: true + enabled: + type: boolean + has_override: + type: boolean + connection_status: type: string enum: - - oauth_auto - - headers - - none - transport: + - connected + - not_connected + McpServerUserAccessListResponse: + type: object + properties: + data: + type: array + items: + $ref: '#/components/schemas/McpServerUserAccessItem' + default_user_access: type: string enum: - - http - - sse - secret_mappings: + - allow + - deny + total: + type: integer + has_more: + type: boolean + BulkUpdateMcpServerUserAccess: + type: object + properties: + user_access: type: array items: - $ref: '#/components/schemas/SecretMapping' - McpIntegrationCreateResponse: + type: object + required: + - user_id + - enabled + properties: + user_id: + type: string + enabled: + type: boolean + default_user_access: + type: string + enum: + - allow + - deny + McpServerUserAccessBulkUpdateResponse: type: object properties: - id: - type: string - format: uuid - slug: - type: string - McpIntegration: + success: + type: boolean + McpServerConnectionItem: type: object properties: - id: + user_id: type: string format: uuid - name: - type: string - description: - type: string - nullable: true - owner_id: - type: string - status: - type: string + connected: + type: boolean created_at: type: string format: date-time last_updated_at: type: string format: date-time - configurations: - type: object - nullable: true - global_workspace_access: - type: object - nullable: true - workspace_id: - type: string - nullable: true - slug: - type: string - url: - type: string - format: uri - auth_type: - type: string - enum: - - oauth_auto - - oauth_client_credentials - - headers - - none - transport: - type: string - enum: - - http - - sse - - interactive - type: - type: string - enum: - - workspace - - organisation - secret_mappings: + McpServerConnectionsListResponse: + type: object + properties: + data: type: array items: - $ref: '#/components/schemas/SecretMapping' - McpIntegrationListItem: + $ref: '#/components/schemas/McpServerConnectionItem' + total: + type: integer + has_more: + type: boolean + McpServerConnectionDeleteResponse: type: object properties: - id: + success: + type: boolean + CreateDeploymentRequest: + type: object + required: + - name + properties: + organisation_id: type: string format: uuid name: type: string - owner_id: - type: string - status: + slug: type: string + minLength: 1 + maxLength: 50 type: type: string enum: - - workspace - - organisation - url: + - production + - non_production + default: production + deployment_config: + type: object + is_default: + type: boolean + auth_settings: + $ref: '#/components/schemas/DeploymentAuthSettingsInput' + tags: + $ref: '#/components/schemas/DeploymentTags' + DeploymentAuthSettings: + type: object + properties: + gateway_base_url: type: string format: uri - auth_type: + mcp_gateway_base_url: type: string - enum: - - oauth_auto - - headers - - none - transport: + format: uri + private_link_endpoint: type: string + format: uri + use_private_link_proxy: + type: integer enum: - - http - - sse - - interactive - configurations: - type: object - created_at: - type: string - format: date-time - last_updated_at: - type: string - format: date-time - slug: - type: string - workspace_id: - type: string - nullable: true - description: - type: string - nullable: true - workspaces_count: - type: number - nullable: true - secret_mappings: + - 0 + - 1 + is_dataservice_hosted: + type: integer + enum: + - 0 + - 1 + is_playground_proxy_allowed: + type: integer + enum: + - 0 + - 1 + disable_portkey_gateway: + type: integer + enum: + - 0 + - 1 + workspaces_allowed: type: array items: - $ref: '#/components/schemas/SecretMapping' - McpIntegrationListResponse: - type: object - properties: - data: + type: string + jwt_subs_allowed: type: array items: - $ref: '#/components/schemas/McpIntegrationListItem' - total: - type: integer - has_more: - type: boolean - UpdateMcpIntegration: + type: string + jwt_sub_workspace_mapping: + type: object + additionalProperties: + type: string + DeploymentAuthSettingsInput: type: object - minProperties: 1 properties: - name: - type: string - description: - type: string - nullable: true - configurations: - type: object - properties: - custom_headers: - type: object - additionalProperties: true - passthrough_header: - type: object - additionalProperties: true - additionalProperties: true - url: + gateway_base_url: type: string format: uri - auth_type: + mcp_gateway_base_url: type: string + format: uri + is_dataservice_hosted: + type: integer enum: - - oauth_auto - - headers - - none - transport: - type: string + - 0 + - 1 + is_playground_proxy_allowed: + type: integer enum: - - http - - sse - secret_mappings: + - 0 + - 1 + workspaces_allowed: type: array items: - $ref: '#/components/schemas/SecretMapping' - McpIntegrationWorkspaceItem: + type: string + jwt_subs_allowed: + type: array + items: + type: string + jwt_sub_workspace_mapping: + type: object + additionalProperties: + type: string + DeploymentCreateResponse: type: object properties: id: type: string - enabled: - type: boolean - status: + format: uuid + organisation_id: type: string - created_at: + format: uuid + client_auth: type: string - format: date-time - last_updated_at: + credentials: + allOf: + - $ref: '#/components/schemas/DeploymentCredentials' + object: type: string - format: date-time - McpIntegrationWorkspacesListResponse: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/McpIntegrationWorkspaceItem' - global_workspace_access: - type: object - nullable: true - total: - type: integer - McpIntegrationWorkspacesLegacyResponse: - type: object - properties: - workspaces: - type: array - items: - $ref: '#/components/schemas/McpIntegrationWorkspaceItem' - global_workspace_access: - type: object - nullable: true - BulkUpdateMcpIntegrationWorkspaces: + enum: + - deployment + DeploymentCredentials: type: object - required: - - workspaces properties: - workspaces: - type: array - minItems: 0 - items: + username: + type: string + password: + type: string + DeploymentDetailResponse: + allOf: + - $ref: '#/components/schemas/DeploymentListItem' + - type: object + properties: + auth_settings: + allOf: + - $ref: '#/components/schemas/DeploymentAuthSettings' + - type: object + properties: + allow_all_workspaces: + type: integer + enum: + - 0 + - 1 + deployment_config: type: object - required: - - id - - enabled - properties: - id: - type: string - enabled: - type: boolean - global_workspace_access: - type: object - nullable: true - properties: - enabled: - type: boolean - override_existing_workspace_access: - type: boolean - default: false - McpIntegrationCapabilityItem: + nullable: true + workspaces: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + slug: + type: string + credentials: + allOf: + - $ref: '#/components/schemas/DeploymentCredentials' + client_auth: + type: string + DeploymentListItem: type: object properties: + id: + type: string + format: uuid name: type: string + slug: + type: string type: type: string enum: - - tool - - prompt - - resource - - resource_template - title: + - production + - non_production + status: type: string - nullable: true - description: + enum: + - active + - archived + is_default: + type: integer + enum: + - 0 + - 1 + connection_status: + type: string + enum: + - healthy + - unhealthy + - unknown + created_by: type: string - nullable: true - icons: - type: array - nullable: true - enabled: - type: boolean created_at: type: string format: date-time last_updated_at: type: string format: date-time - input_schema: - type: object - nullable: true - output_schema: - type: object - nullable: true - execution: - type: object - nullable: true - annotations: - type: object - nullable: true - arguments: - type: array - nullable: true - uri: + last_synced_at: type: string + format: date-time nullable: true - uri_template: + last_resynced_at: type: string + format: date-time nullable: true - mime_type: + tags: + $ref: '#/components/schemas/DeploymentTags' + object: type: string - nullable: true - size: - type: number - nullable: true - McpIntegrationCapabilitiesCounts: + enum: + - deployment + DeploymentPingResponse: type: object properties: - tools: - type: object - properties: - total: - type: integer - enabled: - type: integer - prompts: - type: object - properties: - total: - type: integer - enabled: - type: integer - resources: - type: object - properties: - total: - type: integer - enabled: - type: integer - resource_templates: + status: + type: string + enum: + - healthy + - partial + - unhealthy + gateway_base_url: + type: string + format: uri + outbound: type: object properties: - total: - type: integer - enabled: - type: integer - McpIntegrationCapabilitiesListResponse: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/McpIntegrationCapabilityItem' - counts: - $ref: '#/components/schemas/McpIntegrationCapabilitiesCounts' - total: - type: integer - has_more: - type: boolean - BulkUpdateMcpIntegrationCapabilities: - type: object - required: - - capabilities - properties: - capabilities: - type: array - minItems: 1 - items: - type: object - required: - - name - - type - - enabled - properties: - name: - type: string - type: - type: string - enum: - - tool - - prompt - - resource - enabled: - type: boolean - McpIntegrationCapabilitiesBulkUpdateResponse: + status: + type: string + enum: + - healthy + - unhealthy + - unreachable + status_code: + type: integer + version: + type: string + error: + type: string + inbound: + type: object + properties: + status: + type: string + enum: + - healthy + - failed + error: + type: string + object: + type: string + enum: + - deployment + DeploymentTags: type: object - properties: - success: - type: boolean - McpIntegrationMetadata: + nullable: true + additionalProperties: + type: string + UpdateDeploymentRequest: type: object properties: - server_name: + name: type: string - nullable: true - server_version: + type: type: string - nullable: true - protocol_version: + enum: + - production + - non_production + status: type: string - nullable: true - capability_flags: + enum: + - active + - archived + deployment_config: type: object nullable: true - sync_status: - type: string - nullable: true - last_synced_at: - type: string - format: date-time - nullable: true - sync_error: - type: string - nullable: true - CreateMcpServer: + is_default: + type: boolean + rotate_auth: + type: boolean + override_existing: + type: boolean + auth_settings: + allOf: + - $ref: '#/components/schemas/DeploymentAuthSettingsInput' + - type: object + properties: + allow_all_workspaces: + type: boolean + remove_workspaces_allowed: + type: array + items: + type: string + remove_subs_allowed: + type: array + items: + type: string + tags: + $ref: '#/components/schemas/DeploymentTags' + AnthropicConfiguration: type: object - required: - - name - - mcp_integration_id + description: '' properties: - workspace_id: + provider_auth_type: type: string - format: uuid - name: + enum: + - apiKey + - wif + default: apiKey + description: '' + anthropic_inspect_stream_for_overloaded_error: + type: boolean + description: '' + oauth_token_endpoint: type: string - minLength: 1 - maxLength: 255 - description: + description: '' + oauth_client_id: type: string - nullable: true - maxLength: 500 - mcp_integration_id: + description: '' + oauth_client_secret: type: string - slug: + description: '' + oauth_scope: type: string - pattern: ^[a-zA-Z0-9_-]+$ - minLength: 3 - maxLength: 50 - McpServerCreateResponse: - type: object - properties: - id: + description: '' + wif_identity_source: type: string - format: uuid - slug: + enum: + - configuredIdp + default: configuredIdp + description: '' + oauth_audience: type: string - McpServer: - type: object - properties: - id: + description: '' + anthropic_federation_rule_id: type: string - format: uuid - slug: + description: '' + anthropic_organization_id: type: string - name: + description: '' + anthropic_service_account_id: type: string - status: + description: '' + anthropic_workspace_id: type: string + description: '' + is_key_required: + type: boolean + default: true + description: '' + CreateEgressAllowlistRequest: + type: object + required: + - domain + properties: + domain: + $ref: '#/components/schemas/EgressAllowlistDomain' description: type: string nullable: true - created_at: - type: string - format: date-time - mcp_integration_id: - type: string - mcp_integration_details: - type: object - nullable: true - properties: - id: - type: string - slug: - type: string - status: - type: string - configurations: - type: object - nullable: true - url: - type: string - format: uri - transport: - type: string - auth_type: - type: string - workspace_id: - type: string - nullable: true - McpServerListItem: + maxLength: 500 + EgressAllowlistDomain: + type: string + minLength: 1 + maxLength: 255 + description: '' + EgressAllowlistEntry: type: object properties: id: @@ -18497,600 +20151,715 @@ components: format: uuid organisation_id: type: string - name: + format: uuid + domain: type: string description: type: string nullable: true status: type: string - created_at: - type: string - format: date-time - owner_id: - type: string - slug: - type: string - workspace_id: - type: string - nullable: true - mcp_integration_id: - type: string - mcp_integration_slug: - type: string - nullable: true - mcp_integration_url: + enum: + - active + created_by: type: string - format: uri + format: uuid nullable: true - auth_type: - type: string - workspace_name: + created_at: type: string - nullable: true - workspace_slug: + format: date-time + last_updated_at: type: string - nullable: true - url: + format: date-time + object: type: string - format: uri - McpServerListResponse: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/McpServerListItem' - total: - type: integer - UpdateMcpServer: + enum: + - egress-allowlist + UpdateEgressAllowlistRequest: type: object + description: '' minProperties: 1 + anyOf: + - required: + - domain + - required: + - description properties: - name: - type: string - minLength: 1 - maxLength: 255 + domain: + $ref: '#/components/schemas/EgressAllowlistDomain' description: type: string nullable: true maxLength: 500 - McpServerTestResponse: + AccessPolicyListItem: type: object properties: - success: + id: + type: string + format: uuid + name: + type: string + description: + type: string + nullable: true + enabled: type: boolean - status_code: + effect: + type: string + enum: + - allow + - deny + allow_all_users: + type: boolean + description: '' + allow_all_agents: + type: boolean + description: '' + target_server_count: type: integer - nullable: true - response_time_ms: + description: '' + target_provider_count: type: integer - nullable: true - url: + description: '' + version: + type: integer + status: + type: string + enum: + - active + workspace_id: + type: string + format: uuid + organisation_id: + type: string + format: uuid + created_by: type: string - format: uri nullable: true - server_name: + created_at: type: string - error: + format: date-time + last_updated_at: type: string - nullable: true - McpServerCapabilityItem: + format: date-time + object: + type: string + enum: + - access + CreateAccessPolicyRequest: type: object + required: + - name + - subjects + - targets properties: - name: - type: string - type: + workspace_id: type: string - enum: - - tool - - prompt - - resource - - resource_template - title: + description: '' + name: type: string - nullable: true + minLength: 1 + maxLength: 64 + description: '' description: type: string nullable: true - icons: + maxLength: 256 + effect: + type: string + enum: + - allow + - deny + description: '' + subjects: type: array - nullable: true + minItems: 1 + items: + $ref: '#/components/schemas/AccessPolicySubject' + targets: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/AccessPolicyTarget' enabled: type: boolean - integration_enabled: - type: boolean - nullable: true - input_schema: - type: object - nullable: true - output_schema: - type: object - nullable: true - execution: - type: object - nullable: true - annotations: - type: object - nullable: true - arguments: - type: array - nullable: true - uri: - type: string - nullable: true - uri_template: + default: true + AccessPolicyTarget: + oneOf: + - $ref: '#/components/schemas/AccessPolicyMcpServerTarget' + - $ref: '#/components/schemas/AccessPolicyProviderTarget' + discriminator: + propertyName: type + mapping: + mcp_server: '#/components/schemas/AccessPolicyMcpServerTarget' + provider: '#/components/schemas/AccessPolicyProviderTarget' + AccessPolicyProviderTarget: + type: object + required: + - type + - provider_id + properties: + type: type: string - nullable: true - mime_type: + enum: + - provider + provider_id: type: string - nullable: true - size: - type: number - nullable: true - McpServerCapabilitiesCounts: + description: '' + models: + description: '' + oneOf: + - type: string + enum: + - ALL + - type: array + minItems: 1 + items: + type: string + minLength: 1 + AccessPolicyMcpServerTarget: type: object + required: + - type + - server_id + - tools properties: + type: + type: string + enum: + - mcp_server + server_id: + type: string + description: '' tools: - type: object - properties: - total: - type: integer - enabled: - type: integer - prompts: - type: object - properties: - total: - type: integer - enabled: - type: integer - resources: - type: object - properties: - total: - type: integer - enabled: - type: integer - resource_templates: - type: object - properties: - total: - type: integer - enabled: - type: integer - McpServerCapabilitiesListResponse: + description: '' + oneOf: + - type: string + enum: + - ALL + - type: array + minItems: 1 + items: + type: string + minLength: 1 + AccessPolicySubject: type: object + required: + - type + - id properties: - data: - type: array - items: - $ref: '#/components/schemas/McpServerCapabilityItem' - counts: - $ref: '#/components/schemas/McpServerCapabilitiesCounts' - total: - type: integer - has_more: - type: boolean - BulkUpdateMcpServerCapabilities: + type: + type: string + enum: + - user + - group + - agent + id: + type: string + description: '' + UpdateAccessPolicyRequest: type: object required: - - capabilities + - version + - subjects + - targets properties: - capabilities: + version: + type: integer + minimum: 1 + description: '' + name: + type: string + minLength: 1 + maxLength: 64 + description: + type: string + nullable: true + maxLength: 256 + effect: + type: string + enum: + - allow + - deny + description: '' + subjects: type: array minItems: 1 items: - type: object - required: - - name - - type - - enabled - properties: - name: - type: string - type: - type: string - enum: - - tool - - prompt - - resource - enabled: - type: boolean - McpServerCapabilitiesBulkUpdateResponse: - type: object - properties: - success: + $ref: '#/components/schemas/AccessPolicySubject' + targets: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/AccessPolicyTarget' + enabled: type: boolean - McpServerUserAccessItem: + AccessPolicy: type: object properties: - user_id: + id: type: string - first_name: + format: uuid + name: type: string - nullable: true - last_name: + description: type: string nullable: true enabled: type: boolean - has_override: - type: boolean - connection_status: - type: string - enum: - - connected - - not_connected - McpServerUserAccessListResponse: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/McpServerUserAccessItem' - default_user_access: + effect: type: string enum: - allow - deny - total: - type: integer - has_more: - type: boolean - BulkUpdateMcpServerUserAccess: - type: object - properties: - user_access: + subjects: type: array - items: - type: object - required: - - user_id - - enabled - properties: - user_id: - type: string - enabled: - type: boolean - default_user_access: - type: string - enum: - - allow - - deny - McpServerUserAccessBulkUpdateResponse: - type: object - properties: - success: - type: boolean - McpServerConnectionItem: - type: object - properties: - user_id: + items: + $ref: '#/components/schemas/AccessPolicySubjectDetails' + targets: + type: array + items: + $ref: '#/components/schemas/AccessPolicyTarget' + version: + type: integer + description: '' + status: + type: string + enum: + - active + workspace_id: type: string format: uuid - connected: - type: boolean + organisation_id: + type: string + format: uuid + created_by: + type: string + nullable: true created_at: type: string format: date-time last_updated_at: type: string format: date-time - McpServerConnectionsListResponse: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/McpServerConnectionItem' - total: - type: integer - has_more: - type: boolean - McpServerConnectionDeleteResponse: - type: object - properties: - success: - type: boolean - CreateDeploymentRequest: + object: + type: string + enum: + - access + AccessPolicySubjectDetails: type: object - required: - - name properties: - organisation_id: + type: type: string - format: uuid + enum: + - user + - group + - agent + id: + type: string + description: '' name: type: string - slug: + nullable: true + description: '' + email: + type: string + nullable: true + description: '' + CreateMessageResponse: + type: object + properties: + id: type: string - minLength: 1 - maxLength: 50 type: type: string enum: - - production - - non_production - default: production - deployment_config: - type: object - is_default: - type: boolean - auth_settings: - $ref: '#/components/schemas/DeploymentAuthSettingsInput' - tags: - $ref: '#/components/schemas/DeploymentTags' - DeploymentAuthSettings: - type: object - properties: - gateway_base_url: + - message + role: type: string - format: uri - mcp_gateway_base_url: + enum: + - assistant + model: type: string - format: uri - private_link_endpoint: + content: + type: array + items: + $ref: '#/components/schemas/AnthropicContentBlock' + stop_reason: type: string - format: uri - use_private_link_proxy: - type: integer enum: - - 0 - - 1 - is_dataservice_hosted: + - end_turn + - max_tokens + - stop_sequence + - tool_use + - pause_turn + stop_sequence: + type: string + nullable: true + usage: + $ref: '#/components/schemas/AnthropicUsage' + AnthropicUsage: + type: object + properties: + input_tokens: type: integer - enum: - - 0 - - 1 - is_playground_proxy_allowed: + output_tokens: type: integer - enum: - - 0 - - 1 - disable_portkey_gateway: + cache_creation_input_tokens: + type: integer + cache_read_input_tokens: type: integer + AnthropicContentBlock: + oneOf: + - $ref: '#/components/schemas/AnthropicTextContent' + - $ref: '#/components/schemas/AnthropicImageContent' + - $ref: '#/components/schemas/AnthropicDocumentContent' + - $ref: '#/components/schemas/AnthropicToolUseContent' + - $ref: '#/components/schemas/AnthropicToolResultContent' + - $ref: '#/components/schemas/AnthropicThinkingContent' + - $ref: '#/components/schemas/AnthropicRedactedThinkingContent' + AnthropicRedactedThinkingContent: + type: object + required: + - type + - data + properties: + type: + type: string enum: - - 0 - - 1 - workspaces_allowed: - type: array - items: - type: string - jwt_subs_allowed: - type: array - items: - type: string - jwt_sub_workspace_mapping: - type: object - additionalProperties: - type: string - DeploymentAuthSettingsInput: + - redacted_thinking + data: + type: string + AnthropicThinkingContent: type: object + required: + - type + - thinking + - signature properties: - gateway_base_url: + type: type: string - format: uri - mcp_gateway_base_url: + enum: + - thinking + thinking: + type: string + signature: + type: string + AnthropicToolResultContent: + type: object + required: + - type + - tool_use_id + properties: + type: type: string - format: uri - is_dataservice_hosted: - type: integer enum: - - 0 - - 1 - is_playground_proxy_allowed: - type: integer + - tool_result + tool_use_id: + type: string + content: + oneOf: + - type: string + - type: array + items: + oneOf: + - $ref: '#/components/schemas/AnthropicTextContent' + - $ref: '#/components/schemas/AnthropicImageContent' + is_error: + type: boolean + AnthropicImageContent: + type: object + required: + - type + - source + properties: + type: + type: string enum: - - 0 - - 1 - workspaces_allowed: - type: array - items: - type: string - jwt_subs_allowed: - type: array - items: - type: string - jwt_sub_workspace_mapping: - type: object - additionalProperties: - type: string - DeploymentCreateResponse: + - image + source: + $ref: '#/components/schemas/AnthropicImageSource' + AnthropicImageSource: type: object + required: + - type properties: - id: + type: type: string - format: uuid - organisation_id: + enum: + - base64 + - url + media_type: type: string - format: uuid - client_auth: + enum: + - image/jpeg + - image/png + - image/gif + - image/webp + description: '' + data: type: string - credentials: - allOf: - - $ref: '#/components/schemas/DeploymentCredentials' - object: + description: '' + url: type: string - enum: - - deployment - DeploymentCredentials: + description: '' + AnthropicTextContent: type: object + required: + - type + - text properties: - username: + type: type: string - password: + enum: + - text + text: type: string - DeploymentDetailResponse: - allOf: - - $ref: '#/components/schemas/DeploymentListItem' - - type: object - properties: - auth_settings: - allOf: - - $ref: '#/components/schemas/DeploymentAuthSettings' - - type: object - properties: - allow_all_workspaces: - type: integer - enum: - - 0 - - 1 - deployment_config: - type: object - nullable: true - workspaces: - type: array - items: - type: object - properties: - id: - type: string - format: uuid - slug: - type: string - credentials: - allOf: - - $ref: '#/components/schemas/DeploymentCredentials' - client_auth: - type: string - DeploymentListItem: + AnthropicToolUseContent: type: object + required: + - type + - id + - name + - input properties: + type: + type: string + enum: + - tool_use id: type: string - format: uuid name: type: string - slug: - type: string + input: + type: object + AnthropicDocumentContent: + type: object + required: + - type + - source + properties: type: type: string enum: - - production - - non_production - status: + - document + source: + $ref: '#/components/schemas/AnthropicDocumentSource' + title: type: string - enum: - - active - - archived - is_default: - type: integer - enum: - - 0 - - 1 - connection_status: + context: + type: string + citations: + type: object + properties: + enabled: + type: boolean + AnthropicDocumentSource: + type: object + required: + - type + properties: + type: type: string enum: - - healthy - - unhealthy - - unknown - created_by: + - base64 + - url + - text + - content + media_type: type: string - created_at: + enum: + - application/pdf + - text/plain + description: '' + data: type: string - format: date-time - last_updated_at: + description: '' + url: type: string - format: date-time - last_synced_at: + description: '' + text: type: string - format: date-time - nullable: true - last_resynced_at: + description: '' + CreateAnthropicMessageRequest: + type: object + required: + - model + - messages + - max_tokens + description: '' + properties: + model: type: string - format: date-time - nullable: true - tags: - $ref: '#/components/schemas/DeploymentTags' - object: + description: '' + messages: + type: array + items: + $ref: '#/components/schemas/AnthropicMessage' + description: '' + max_tokens: + type: integer + description: '' + system: + $ref: '#/components/schemas/AnthropicSystemContent' + stream: + type: boolean + default: false + description: '' + temperature: + type: number + minimum: 0 + maximum: 1 + description: '' + top_p: + type: number + description: '' + top_k: + type: integer + description: '' + stop_sequences: + type: array + items: + type: string + description: '' + tools: + type: array + items: + $ref: '#/components/schemas/AnthropicTool' + description: '' + tool_choice: + type: object + description: '' + properties: + type: + type: string + enum: + - auto + - any + - tool + - none + name: + type: string + description: '' + thinking: + $ref: '#/components/schemas/AnthropicThinkingConfig' + metadata: + type: object + properties: + user_id: + type: string + AnthropicThinkingConfig: + type: object + required: + - type + properties: + type: type: string enum: - - deployment - DeploymentPingResponse: + - enabled + - disabled + - adaptive + budget_tokens: + type: integer + description: '' + AnthropicTool: type: object + required: + - name + - input_schema properties: - status: + name: type: string - enum: - - healthy - - partial - - unhealthy - gateway_base_url: + description: type: string - format: uri - outbound: + input_schema: + type: object + description: '' + cache_control: type: object properties: - status: + type: type: string enum: - - healthy - - unhealthy - - unreachable - status_code: - type: integer - version: - type: string - error: - type: string - inbound: + - ephemeral + AnthropicSystemContent: + oneOf: + - type: string + description: '' + - type: array + items: type: object + required: + - type + - text properties: - status: + type: type: string enum: - - healthy - - failed - error: + - text + text: type: string - object: + cache_control: + type: object + properties: + type: + type: string + enum: + - ephemeral + AnthropicMessage: + type: object + required: + - role + - content + properties: + role: type: string enum: - - deployment - DeploymentTags: + - user + - assistant + content: + oneOf: + - type: string + - type: array + items: + $ref: '#/components/schemas/AnthropicContentBlock' + CountMessageTokensResponse: type: object - nullable: true - additionalProperties: - type: string - UpdateDeploymentRequest: + properties: + input_tokens: + type: integer + description: '' + CountMessageTokensRequest: type: object + required: + - model + - messages + description: '' properties: - name: - type: string - type: - type: string - enum: - - production - - non_production - status: + model: type: string - enum: - - active - - archived - deployment_config: + description: '' + messages: + type: array + items: + $ref: '#/components/schemas/AnthropicMessage' + system: + $ref: '#/components/schemas/AnthropicSystemContent' + tools: + type: array + items: + $ref: '#/components/schemas/AnthropicTool' + tool_choice: type: object - nullable: true - is_default: - type: boolean - rotate_auth: - type: boolean - override_existing: - type: boolean - auth_settings: - allOf: - - $ref: '#/components/schemas/DeploymentAuthSettingsInput' - - type: object - properties: - allow_all_workspaces: - type: boolean - remove_workspaces_allowed: - type: array - items: - type: string - remove_subs_allowed: - type: array - items: - type: string - tags: - $ref: '#/components/schemas/DeploymentTags' + properties: + type: + type: string + enum: + - auto + - any + - tool + - none + name: + type: string + thinking: + $ref: '#/components/schemas/AnthropicThinkingConfig' diff --git a/overlays/docs-prose.yaml b/overlays/docs-prose.yaml index 04ac356..e6f835c 100644 --- a/overlays/docs-prose.yaml +++ b/overlays/docs-prose.yaml @@ -1644,3 +1644,132 @@ actions: claims: [] origin_kind: human text_digest: '' +- target: $.paths['/analytics/groups/a2a'].get + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/analytics/groups/mcp'].get + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/analytics/groups/workspaces'].get + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.tags[?(@.name=='Egress Allowlist')] + update: + description: '' +- target: $.paths['/egress-allowlist'].get + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/egress-allowlist'].post + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/egress-allowlist/{egressAllowlistId}'].get + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/egress-allowlist/{egressAllowlistId}'].put + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/egress-allowlist/{egressAllowlistId}'].delete + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.tags[?(@.name=='Access Policies')] + update: + description: '' +- target: $.paths['/policies/access'].post + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/policies/access'].get + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/policies/access/{accessPolicyId}'].get + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/policies/access/{accessPolicyId}'].put + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/policies/access/{accessPolicyId}'].delete + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.tags[?(@.name=='Messages')] + update: + description: '' +- target: $.paths['/messages'].post + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' +- target: $.paths['/messages/count_tokens'].post + update: + summary: '' + description: '' + x-airs-provenance: + claims: [] + origin_kind: human + text_digest: '' diff --git a/tags-map.yaml b/tags-map.yaml index 7d9c0e9..376463f 100644 --- a/tags-map.yaml +++ b/tags-map.yaml @@ -69,6 +69,11 @@ tags: group: inference - to: Decisions group: inference + # The Anthropic Messages API, from Portkey-AI/openapi 9283142, after the base + # linkage closed. No `from`: it was never in the base. Not to be confused + # with the thread messages under Assistants. + - to: Messages + group: inference - from: OCR to: OCR group: inference @@ -160,6 +165,10 @@ tags: - from: Api-Keys to: API Keys group: administration + # From Portkey-AI/openapi 2bc08ce, after the base linkage closed. No `from`: + # it was never in the base. + - to: Access Policies + group: administration - from: Rate Limits Policies to: Rate Limit Policies group: administration @@ -179,6 +188,11 @@ tags: - from: Usage Limits Policies to: Usage Limit Policies group: administration + # From Portkey-AI/openapi 8f91369, after the base linkage closed, where it + # is "Egress-Allowlist". No `from`: it was never in the base. Renamed to the + # Title Case, space-separated convention above. + - to: Egress Allowlist + group: administration # --- Observability ----------------------------------------------------- - from: Analytics > Graphs